Update README.md, correct error in installation instructions

robocomp · Dec 18, 2023 · 8a633ee · 8a633ee
1 parent 0c22e1b
commit 8a633ee
Showing 1 changed file with 60 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -51,80 +51,95 @@ Tested in Ubuntu 20.04 and 22.04
 Before you begin the installation, make sure you have the following prerequisites installed on your system:
 
 ### Prerequisites for Robocomp Installation
-
-- sudo apt update
-- sudo apt install python3 python3-pip cmake vim git wget -y
-- pip3 install vcstool colcon-common-extensions
-- sudo apt install qtbase5-dev libqt5xmlpatterns5-dev libopenscenegraph-dev libgsl-dev 
+```bash
+sudo apt update
+sudo apt install python3 python3-pip cmake vim git wget qtbase5-dev libqt5xmlpatterns5-dev libopenscenegraph-dev libgsl-dev 
+pip3 install vcstool colcon-common-extensions 
+```
 
 ### Prerequisites for Compiling Robocomp Components
-
-- sudo apt install qt6-base-dev
-- pip install PySide2
-- sudo apt install libbz2-dev libssl-dev 
-- pip install zeroc-ice
-- sudo apt install zeroc-icebox zeroc-ice-all-dev libzeroc-icestorm3.7
-- sudo apt install libeigen3-dev meld
+```bash
+sudo apt install qt6-base-dev libbz2-dev libssl-dev zeroc-icebox zeroc-ice-all-dev libzeroc-icestorm3.7 libeigen3-dev meld
+pip install PySide2 zeroc-ice
+```
 
 ## Installation Steps
 
 1. Create a directory for your RoboComp workspace and navigate to it:
-- mkdir -p ~/robocomp_ws/src
-- cd ~/robocomp_ws
+```bash
+mkdir -p ~/robocomp_ws/src
+cd ~/robocomp_ws
+```
 
 2. Download the robocomp.repos file:
-- wget https://raw.githubusercontent.com/robocomp/robocomp2/main/robocomp.repos
+```bash
+wget https://raw.githubusercontent.com/robocomp/robocomp2/main/robocomp.repos
+```
 
-3. Configure environment variables:
-- echo export ROBOCOMP=/home/robocomp/robocomp >> ~/.bashrc
-- echo export PATH="$PATH:/home/usuario/.local/bin" >>  ~/.bashrc
-- source ~/.bashrc
+4. Configure environment variables:
+```bash
+echo "export ROBOCOMP=/home/robocomp/robocomp" >> ~/.bashrc
+echo "export PATH=\$PATH:/home/usuario/.local/bin" >>  ~/.bashrc
+source ~/.bashrc
+```
 
 4. Import RoboComp packages:
-- vcs import src < robocomp.repos
+```bash
+vcs import src < robocomp.repos
+```
 
 5. Install RoboComp command-line tools:
-- pushd . && cd src/robocomp/robocomp_tools/cli/ && pip install . && popd
+```bash
+pushd . && cd src/robocomp/robocomp_tools/cli/ && pip install . && popd
+```
 
 6. Create symbolic links:
-- cd 
-- ln -s robocomp_sw/src/robocomp robocomp
-- cd /home
-- sudo ln -s usuario robocomp
-- cd robocomp/robocomp
-- ln -s robocomp_core/cmake cmake
-- ln -s robocomp_core/classes classes
-- ln -s robocomp_interfaces/interfaces interfaces
-- ln -s robocomp_tools tools
-- ln -r robocomp_cortex cortex
-- mkdir components
-- sudo ln -s /usr/include/eigen3/Eigen/ /usr/include/Eigen
+```bash
+cd 
+ln -s robocomp_ws/src/robocomp robocomp
+```
 
+```bash
+cd /home
+sudo ln -s usuario robocomp
+```
+
+```bash
+cd /home/robocomp/robocomp
+ln -s robocomp_core/cmake cmake
+ln -s robocomp_core/classes classes
+ln -s robocomp_interfaces/interfaces interfaces
+ln -s robocomp_tools tools
+ln -s robocomp_cortex cortex
+mkdir components
+```
+
+```bash
+sudo ln -s /usr/include/eigen3/Eigen/ /usr/include/Eigen
+```
 
 7. Configure rcnode:
 
-    Edit the ~/robocomp/tools/rcnode/rcnode.sh file and change the line:
+    Edit the `~/robocomp/tools/rcnode/rcnode.sh` file and change the line:
 
-	- /opt/robocomp/etc/rcnode.conf
+   `/opt/robocomp/etc/rcnode.conf`
 
-    to
-
-    	- /home/robocomp/robocomp/tools/rcnode/rcnode.conf
+    to:
 
-8. Add an alias for rcnode to your .bashrc:
-- echo alias rcnode='bash /home/robocomp/robocomp/tools/rcnode/rcnode.sh&' >>  ~/.bashrc
-- source ~/.bashrc
+   `/home/robocomp/robocomp/tools/rcnode/rcnode.conf`
+
+9. Add an alias for rcnode to your .bashrc:
+```bash
+echo "alias rcnode='bash /home/robocomp/robocomp/tools/rcnode/rcnode.sh&'" >>  ~/.bashrc
+source ~/.bashrc
+```
 
 
 If you are going to develop with Robocomp it's recommendable to install the following packages too:
 ```bash
 sudo apt-get install yakuake qttools5-dev-tools qt5-assistant meld
-
-and create this link for Eigen includes:
-sudo ln -s /usr/include/eigen3/Eigen/ /usr/include/Eigen
 ```
 
-
 Done! Now let's have some fun.
 
 To test RoboComp with Coppelia you need to: