ros1_ros_cpptemplate: README.md Source File

Go to the documentation of this file.
00001 <!--- Kind of hackish way to make it work on github and Doxygen) -->
00002 
00003 [//]: # (/*! \mainpage ( ROS1 ROS CPP Template */)
00004 
00005 ROS1 ROS CPP Template
00006 =================
00007 
00008 This package is a template for a ROS nodelet package depending on another C++ library package for implementation details.<br>
00009 It is supposed to show the ROS part if using a separate ROS and C++ library packages.
00010 
00011 In this package we are following http://wiki.ros.org/BestPractices as much as possible, where it makes sense.<br>
00012 
00013 Usage
00014 -----
00015 
00016 - Create a catkin_workspace ( Ref : http://wiki.ros.org/catkin/Tutorials/create_a_workspace )
00017 - Add this ros1_cpptemplate package into ``src/`` of the workspace (and maybe more like beginner_tutorials)
00018 - Build the workspace (Ref : http://wiki.ros.org/catkin/Tutorials/using_a_workspace)
00019 - Source the devel workspace::
00020 
00021     $ source devel/setup.bash
00022 
00023 - run the tests of this package::
00024 
00025     $ catkin run_tests ros1_ros_cpptemplate
00026 
00027 - run all the tests::
00028 
00029     $ catkin run_tests
00030 
00031 - build the documentation::
00032 
00033     $ rosdoc_lite src/ros1_template/ros1_ros_cpptemplate -o src/ros1_template/ros1_ros_cpptemplate/doc/
00034 
00035 - launch the demo application::
00036 
00037     $ roslaunch ros1_ros_template standalone.launch --screen
00038 
00039 - install that workspace::
00040 
00041     $ make install
00042 
00043 - source the install workspace::
00044 
00045     $ source install/setup.bash
00046 
00047 
00048 
00049