diff --git a/README.md b/README.md index c97a104980d7bbe62fff3f047ac299494361573f..470f967524198da7ab9fb515d26d36fc4261be40 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,11 @@ # A Complete Panda Gazebo Workspace -Remark: The state outside of the master branch must be considered as "work-in-progress". Only the master branch is stable here. +## Important Remarks: + +- Much of the code in the contained submodules is based on the information [Erdal Pekel's Blog](https://erdalpekel.de/). **Thanks, Erdal!** +- The state outside of the master branch must be considered as "work-in-progress". Only the master branch is stable here. +- Currently, only very simple use cases are contained here. We will gradually update the code. Watch this space! +- The examples only work when *all* projects in this workspace are checked out. ## Requirements @@ -9,7 +14,9 @@ Remark: The state outside of the master branch must be considered as "work-in-pr ## Installation -- clone the repo `git clone --recurse-submodules git@git-st.inf.tu-dresden.de:ceti/ros/panda_gazebo_workspace.git` +- clone the repo + - as a guest: `git clone --recurse-submodules https://git-st.inf.tu-dresden.de/ceti/ros/panda_gazebo_workspace.git` + - as a project member: `git clone --recurse-submodules git@git-st.inf.tu-dresden.de:ceti/ros/panda_gazebo_workspace.git` - change into the workspace `cd panda_gazebo_workspace` - install ROS package dependencies `rosdep install --from-paths .` - build the workspace `catkin build` @@ -20,6 +27,8 @@ Remark: The state outside of the master branch must be considered as "work-in-pr ## Simulations +See the [README.md of the submodule](../../../../sample_applications/-/blob/master/README.md) for more information. + - For planning and simulation based on rviz: `roslaunch panda_simulation simulation.launch` - Execution of a simple motion: `roslaunch sample_applications sample_simple_simulation.launch` - Execution of a simple motion costraint by a blocking object: `roslaunch sample_applications sample_constraint_simulation.launch`