From ae27a7bafc50bae1f289c658f4e8a48c8c606dde Mon Sep 17 00:00:00 2001 From: William Woodall Date: Sun, 1 Jan 2012 01:18:06 -0600 Subject: [PATCH] Update README.md --- README.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 65 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 95169eb..1e6b573 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,66 @@ -# Using Stand Alone +# Serial Communication Library -## \ No newline at end of file +## Documentation + +Coming Soon! + +## Dependencies + +* CMake, for the build system: http://www.cmake.org/ +* Boost, for threading: http://www.boost.org/ +* (Optional) ROS + +## Stand Alone Installation + +Get the source: + + git clone git://github.com/wjwwood/serial.git + cd serial + +Compile the code: + + make + +Or run cmake youself: + + mkdir build && cd build + cmake .. + make + +Install the code (UNIX): + + make + sudo make install + +Uninstall the code (UNIX): + + make + sudo make uninstall + +Build the documentation: + + Comming Soon! + +## License + +The BSD License + +Copyright (c) 2011 William Woodall + +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.