Skip to content

Commit e541749

Browse files
authored
Update install docs (#609)
2 parents b226971 + aef1091 commit e541749

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

bitbots_misc/bitbots_docs/docs/manual/tutorials/cl_simulation_testing_setup.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,19 @@ As such you can lookup some of the needed requirements there.
1010

1111
- have an LDAP mafiasi account for access to the CLs
1212
- have ros2 aliases setup (see linked docs)
13-
- have GitHub ssh access setup for bitbots_main (see linked docs)
1413

1514
**1. Setup and download our software**
1615

1716
- SSH into the ``cl0*`` with your mafiasi user
17+
- Add your SSH key to GitHub to access and sync our repositories
18+
- If you don't know what I am talking about or you don't yet have a SSH key, follow this guide: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys
19+
- Go to your account settings and add your SSH key (the ``.pub`` file) to `GitHub <https://github.com/settings/keys>`_
1820
- setup bitbots_main in your home directory
1921

2022
.. code-block:: bash
2123
22-
mkdir -p "~/colcon_ws/src"
23-
cd "~/colcon_ws/src"
24+
mkdir -p "$HOME/colcon_ws/src"
25+
cd "$HOME/colcon_ws/src"
2426
git clone [email protected]:bit-bots/bitbots_main.git && cd bitbots_main
2527
make install-no-root
2628

bitbots_misc/bitbots_docs/docs/manual/tutorials/install_software_ros2.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ If you want to install it, you can do so by running ``make webots`` in the bitbo
7070

7171
**3. Download our software**
7272

73-
- Create a GitHub account, if not already done (see `here <http://doku.bit-bots.de/private/manual/dienste_accounts.html>` for further information)
73+
- Create a GitHub account, if not already done (see `here <http://doku.bit-bots.de/private/manual/dienste_accounts.html>`_ for further information)
7474
- Add your SSH key to GitHub to access and sync our repositories
7575
- If you don't know what I am talking about or you don't yet have a SSH key, follow this guide: https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys
7676
- Go to your account settings and add your SSH key (the ``.pub`` file) to `GitHub <https://github.com/settings/keys>`_
@@ -137,6 +137,8 @@ In case you are not using the bash shell, replace ``~/.bashrc`` and ``bash`` wit
137137
138138
EOF
139139
140+
source ~/.bashrc
141+
140142
- Configure the robot hostnames, see :doc:`configure_hostnames`.
141143
142144
Notes

0 commit comments

Comments
 (0)