diff --git a/README.md b/README.md index 373033d..2e8eb1a 100644 --- a/README.md +++ b/README.md @@ -44,19 +44,33 @@ ## Installation +### Debian Packages + +To install YASMIN and its packages, use the following command: + +```shell +sudo apt install ros-$ROS_DISTRO-yasmin ros-$ROS_DISTRO-yasmin-* +``` + +### Building from Source + +Follow these steps to build the source code from this repository: + ```shell -$ cd ~/ros2_ws/src -$ git clone https://github.com/uleroboticsgroup/yasmin.git -$ cd ~/ros2_ws -$ rosdep install --from-paths src --ignore-src -r -y -$ cd ~/ros2_ws -$ colcon build +cd ~/ros2_ws/src +git clone https://github.com/uleroboticsgroup/yasmin.git +cd ~/ros2_ws +rosdep install --from-paths src --ignore-src -r -y +cd ~/ros2_ws +colcon build ``` -If you are using a deprecated ROS 2 distro (like Foxy or Galactic) or the Rolling distro, you may need to install the example interfaces: +#### Note for Deprecated or Rolling ROS 2 Distros + +If you are using a deprecated ROS 2 distribution (e.g., Foxy or Galactic) or the Rolling distribution, install the example interfaces: ```shell -$ sudo apt install -y ros-$ROS_DISTRO-example-interfaces +sudo apt install -y ros-$ROS_DISTRO-example-interfaces ``` ## Docker @@ -65,27 +79,27 @@ If your operating system doesn't support ROS 2, docker is a great alternative. Y ```shell ## Assuming you are in the YASMIN project directory -$ docker build -t yasmin . +docker build -t yasmin . ``` To use a shortcut the docker build, you may use the following command: ```shell ## Assuming you are in the YASMIN project directory -$ make docker_build +make docker_build ``` After the image is created, run a docker container with the following command: ```shell -$ docker run -it --net=host --ipc=host --privileged --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" --volume="${XAUTHORITY}:/root/.Xauthority" --entrypoint /bin/bash yasmin +docker run -it --net=host --ipc=host --privileged --env="DISPLAY" --env="QT_X11_NO_MITSHM=1" --volume="/tmp/.X11-unix:/tmp/.X11-unix:rw" --volume="${XAUTHORITY}:/root/.Xauthority" --entrypoint /bin/bash yasmin ``` To use a shortcut the docker run, you may use following command: ```shell ## Assuming you are in the YASMIN project directory -$ make docker_run +make docker_run ``` ## Demos @@ -97,7 +111,7 @@ There are some examples, for both Python and C++, that can be found in [yasmin_d #### Vanilla Demo (FSM) ```shell -$ ros2 run yasmin_demos yasmin_demo.py +ros2 run yasmin_demos yasmin_demo.py ```
@@ -262,11 +276,11 @@ if __name__ == "__main__":
#### Service Demo (FSM + ROS 2 Service Client)
```shell
-$ ros2 run yasmin_demos add_two_ints_server
+ros2 run yasmin_demos add_two_ints_server
```
```shell
-$ ros2 run yasmin_demos service_client_demo.py
+ros2 run yasmin_demos service_client_demo.py
```