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

Update documentation (#140)

Browse Source 
* Fix typo and missing dependency in README

* [docs] Update docs: fix deprecation warnings + add missing deps to README
This commit is contained in:
Stephane Poirier 2017-01-20 18:29:03 -05:00 committed by William Woodall
parent 02dfff7883
commit 771e62c220
2 changed files with 1619 additions and 897 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -16,12 +16,20 @@ API Documentation: http://wjwwood.github.com/serial/doc/1.1.0/index.html
### Dependencies
Required:
* [catkin](http://www.ros.org/wiki/catkin) - cmake and Python based buildsystem
* [cmake](http://www.cmake.org) - buildsystem
* [Python](http://www.python.org) - scripting language
* [empy](http://www.alcyone.com/pyos/empy/) - Python templating library
* [catkin_pkg](http://pypi.python.org/pypi/catkin_pkg/) - Runtime Python library for catkin
Optional (for tests):
* [Boost](http://www.boost.org/) - Boost C++ librairies
Optional (for documentation):
* [Doxygen](http://www.doxygen.org/) - Documentation generation tool
* [graphviz](http://www.graphviz.org/) - Graph visualization software
### Install
Get the code:
@ -38,7 +46,7 @@ Build and run the tests:
Build the documentation:
make docs
make doc
Install:

2492
doc/Doxyfile
View File

File diff suppressed because it is too large Load Diff