diff --git a/README.md b/README.md index 9361da7..0b72f76 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,66 @@ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ROS implementation of local goal creator + +## Environment +- Ubuntu 20.04 +- ROS Noetic + +## Install and Build +``` +# clone repository +cd /path/to/your/catkin_ws/src +git clone https://github.com/ToshikiNakamura0412/local_goal_creator_ros.git + +# build +cd /path/to/your/catkin_ws +rosdep install -riy --from-paths src --rosdistro noetic # Install dependencies +catkin build local_goal_creator_ros -DCMAKE_BUILD_TYPE=Release # Release build is recommended +``` + +## How to use +``` +roslaunch local_goal_creator_ros local_goal_creator.launch +``` + +## Running the demo +``` +# clone repository +cd /path/to/your/catkin_ws/src +git clone https://github.com/ToshikiNakamura0412/a_star_ros.git + +# build +cd /path/to/your/catkin_ws +rosdep install -riy --from-paths src --rosdistro noetic +catkin build -DCMAKE_BUILD_TYPE=Release + +# run demo +roslaunch local_goal_creator_ros test.launch +``` + +
+
+