From 80c0ce9b1bb6e47c86ec15ae27c7b3ac2be784cd Mon Sep 17 00:00:00 2001 From: William Woodall Date: Mon, 11 Jun 2012 20:51:18 -0500 Subject: [PATCH] Updating docs and adding a rosinstall file --- README.md | 18 +++++++++++------- serial.rosinstall | 1 + 2 files changed, 12 insertions(+), 7 deletions(-) create mode 100644 serial.rosinstall diff --git a/README.md b/README.md index 81d1bf2..adc8a39 100644 --- a/README.md +++ b/README.md @@ -8,16 +8,16 @@ If you previously were using the `master` branch, that version is now under the If you were previously using the `boostless` branch, that version is now tagged as `v0.2` or `boostless`. -If you were previously using the `new_api` branch, that has become the new `master` branch and will be the new `v1.0` version tag soon. +If you were previously using the `new_api` branch, that has become the new `master` branch and is also tagged `v1.0`. ## Documentation -Coming Soon! +http://wjwwood.github.com/serial/docs/v1.0/index.html ## Dependencies * CMake, for the build system: http://www.cmake.org/ -* (Optional) ROS +* (Optional) ROS: http://ros.org/wiki ## Stand Alone Installation @@ -55,15 +55,15 @@ Build the documentation: Setup workspace (skip if you already have one): mkdir some_ros_workspace - rosws init some_ros_workspace cd some_ros_workspace + rosws init . /opt/ros/fuerte # Replace the path here source setup.bash -Add the rosinstall entry for this stack: +Add the serial unary stack to your ROS workspace: - echo "- git: {local-name: serial, uri: 'https://github.com/wjwwood/serial.git', version: 'master'}" >> .rosinstall + rosws merge REPLACEME -Rerun rosinstall (note this will change your $ROS_PACKAGE_PATH): +Rerun rosinstall to fetch it: rosinstall . source setup.bash @@ -76,6 +76,10 @@ Run the example: rosrun serial serial_example +Use it in your ROS pkg by adding this line to your `manifest.xml`: + + + ## License The BSD License diff --git a/serial.rosinstall b/serial.rosinstall new file mode 100644 index 0000000..7c5cf1e --- /dev/null +++ b/serial.rosinstall @@ -0,0 +1 @@ +- git: {local-name: serial, uri: 'https://github.com/wjwwood/serial.git', version: 'v1.0'} \ No newline at end of file