From 5fb2586a3510751137f620e36aedc1172953537e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20PORTAY?= Date: Thu, 27 Mar 2025 11:55:48 +0100 Subject: [PATCH 1/4] README.md: remove trailing slash in PATH component This removes the unnecessary trailing slash in the PATH component of the source directory of the variable GAZEBO_RESOURCE_PATH. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ec13f01..def85e7 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ This project simulates and controls a robotic arm using **ROS2 Humble**, **Gazeb 6. **Export the settings** ```bash - export GAZEBO_RESOURCE_PATH="~/Robot5A-Simulation/src/robot_description/:/usr/share/gazebo-11/models:/usr/share/gazebo-11" + export GAZEBO_RESOURCE_PATH="~/Robot5A-Simulation/src/robot_description:/usr/share/gazebo-11/models:/usr/share/gazebo-11" export QT_QPA_PLATFORM=xcb ``` @@ -115,7 +115,7 @@ This project simulates and controls a robotic arm using **ROS2 Humble**, **Gazeb ```bash echo "source /opt/ros/humble/setup.bash" >> ~/.bashrc echo "source ~/Robot5A-Simulation/install/setup.bash" >> ~/.bashrc - echo "export GAZEBO_RESOURCE_PATH="~/Robot5A-Simulation/src/robot_description/:/usr/share/gazebo-11/models:/usr/share/gazebo-11"" >> ~/.bashrc + echo "export GAZEBO_RESOURCE_PATH="~/Robot5A-Simulation/src/robot_description:/usr/share/gazebo-11/models:/usr/share/gazebo-11"" >> ~/.bashrc echo "export QT_QPA_PLATFORM=xcb" >> ~/.bashrc ``` From e72b5bb0c72420600fe70aeb0c105adc88734857 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20PORTAY?= Date: Thu, 27 Mar 2025 11:58:07 +0100 Subject: [PATCH 2/4] README.md: escape double quotes in echo This escapes the double quotes to make sure they are actually echo'ed in the .bashrc file. Note: It should fix issue if the sources are cloned at path including whitespaces. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index def85e7..8b7eb04 100644 --- a/README.md +++ b/README.md @@ -115,7 +115,7 @@ This project simulates and controls a robotic arm using **ROS2 Humble**, **Gazeb ```bash echo "source /opt/ros/humble/setup.bash" >> ~/.bashrc echo "source ~/Robot5A-Simulation/install/setup.bash" >> ~/.bashrc - echo "export GAZEBO_RESOURCE_PATH="~/Robot5A-Simulation/src/robot_description:/usr/share/gazebo-11/models:/usr/share/gazebo-11"" >> ~/.bashrc + echo "export GAZEBO_RESOURCE_PATH=\"~/Robot5A-Simulation/src/robot_description:/usr/share/gazebo-11/models:/usr/share/gazebo-11\"" >> ~/.bashrc echo "export QT_QPA_PLATFORM=xcb" >> ~/.bashrc ``` From 12063f4cc47b88da0bda8aecaf650ef2e399ae57 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20PORTAY?= Date: Thu, 27 Mar 2025 12:10:17 +0100 Subject: [PATCH 3/4] README.md: remove duplicated empty lines This removes the empty lines that are duplicated, a single empty line is enough and it is coherent with the whole file. --- README.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/README.md b/README.md index 8b7eb04..f1342f1 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ Robotic Arm

- ## Table of Contents - [Project Description](#project-description) @@ -75,7 +74,6 @@ This project simulates and controls a robotic arm using **ROS2 Humble**, **Gazeb ros-humble-xacro ``` - 3. **Clone the Repository** ```bash @@ -109,7 +107,6 @@ This project simulates and controls a robotic arm using **ROS2 Humble**, **Gazeb export QT_QPA_PLATFORM=xcb ``` - 7. **Write to bashrc for automatic export and source when launching the terminal** ```bash @@ -130,7 +127,6 @@ This project simulates and controls a robotic arm using **ROS2 Humble**, **Gazeb colcon build --symlink-install --cmake-clean-cache ``` - ### Using Docker and dosh Alternatively, you may consider using [Docker](https://www.docker.com/) and the wrapper [dosh](https://gportay.github.io/dosh/). @@ -172,7 +168,6 @@ Alternatively, you may consider using [Docker](https://www.docker.com/) and the __Note__: The run-command file [.bashrc](.bashrc) sources the necessary bits so it is unecessary to source the files `/opt/ros/humble/setup.bash` and `install/setup.bash` manually. - ## Usage ### Launching the Simulation and controlling the robotic arm @@ -242,5 +237,3 @@ This project is licensed under the MIT License. --- *Developed by [Eliott, Omar & Matthieu - ABMI Groupe](https://github.com/ABMI-software/Robot5A-Simulation)* - - From 3bf21b8b5ba17c3bdecd6bba35381fb9f109de11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ga=C3=ABl=20PORTAY?= Date: Thu, 27 Mar 2025 12:16:29 +0100 Subject: [PATCH 4/4] README.md: update contribution section This updates the contribution sections using useful links. --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index f1342f1..4780d32 100644 --- a/README.md +++ b/README.md @@ -205,26 +205,37 @@ The project is structured into several key components: Contributions are welcome! Please follow these steps: -1. **Fork the Repository** -2. **Create a Feature Branch** +1. **Fork the Repository and fork it** + + Create a new [fork](https://github.com/ABMI-software/Robot5A-Simulation/fork). + +2. **Enter the sources** + + ```bash + cd Robot5A-Simulation + ``` + +3. **Create a Feature Branch** ```bash git checkout -b feature/YourFeature ``` -3. **Commit Your Changes** +4. **Commit Your Changes** ```bash git commit -m "Add your feature" ``` -4. **Push to the Branch** +5. **Push to the Branch** ```bash git push origin feature/YourFeature ``` -5. **Open a Pull Request** +6. **Open a Pull Request** + + Open a [pull request](https://github.com/ABMI-software/Robot5A-Simulation/compare) ## Documentation