Myth/serial
1
0
Fork 0
mirror of https://github.com/wjwwood/serial.git synced 2026-01-22 19:54:57 +08:00
Code Issues Projects Releases Wiki Activity

Simply README

Browse Source 
Make README more simple.
This commit is contained in:
Cheng Zhong 2016-01-25 16:28:29 +08:00
parent 91489cd142
commit 1bf516a132
2 changed files with 10 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -8,7 +8,7 @@ This library is in use in several robotics related projects and can be built and
Serial is a class that provides the basic interface common to serial libraries (open, close, read, write, etc..) and requires no extra dependencies. It also provides tight control over timeouts and control over handshaking lines.
For android support, see android/README.
For android support, see android/README.md.
### Documentation

48
android/README.md
View File

@ -1,51 +1,21 @@
# Serial Communication Library for android
# Serial Communication Library for android (JNI API)
This is the android JNI support for Cross-platform, Serial Port library.
<big>The android library is not strictly tested. You should test it yourself and handle any issue.</big>
### Documentation
Website: http://wjwwood.github.com/serial/
This is the Android support for Cross-platform, Serial Port library (JNI API).
### Dependencies
To build the lib:
* NDK r10 (http://developer.android.com/intl/zh-cn/ndk/downloads/index.html)
To build the code:
* NDK r10 (http://developer.android.com/intl/ndk/downloads/index.html)
### Install
Get the code:
git clone https://github.com/chzhong/serial.git
Build:
### Build
cd android
ndk-build
Use:
### About Java API
Use it directly in your native code, or you may seek for a Java bridge here: https://github.com/chzhong/serial-android
If you need to use Java API in android, have a look at https://github.com/chzhong/serial-android.
### License and Author
### License
The MIT License
Copyright (c) 2012 William Woodall, John Harrison
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
### Authors
William Woodall <wjwwood@gmail.com>
John Harrison <ash.gti@gmail.com>
### Contact
William Woodall <william@osrfoundation.org>
See README.md at the root directory.