Skip to content
Snippets Groups Projects
Commit b6ef00af authored by holzheim's avatar holzheim
Browse files

Updated README.md in 00_GettingStarted

parent 4a688897
No related branches found
No related tags found
No related merge requests found
......@@ -46,21 +46,49 @@ After successfull installation, **open** `Docker Desktop`. The GUI should open a
![Docker starting window](images/docker_starting-window.png)*`Docker Desktop` starting window*
### Starting a Container to work with ROS
In the [docker/i2r/](docker/i2r/) directory you can find a *Dockerfile* and a *docker-compose* file. These are used to make shure you can all start with the same working `ROS` environment.
To make sure you can all start with the same working `ROS` environment we use a predefined *image* and *compose* file. Both are stored in this repository at [00_GettingStarted/docker/i2r/](docker/i2r/).
Following the instructions to follow to start the group of containers:
Following the instructions to download the repository to your local machine and start the group of containers:
1. Copy the [docker/i2r/](docker/i2r/) folder into the directory you are using for this course on your local machine.
2. Open `VS Code` and make shure you are in the *your_local_path/docker/i2r/* folder in the terminal.
3. Run the following command to spin up the scenario that is defined in the [docker-compose.yml](docker/i2r/docker-compose.yml) file.
1. Create a folder named ***i2r*** for the contents of the `Introduction to Robotics` course.
2. Open this folder in `VS Code` by either starting `VS Code` from Terminal or by using the GUI.
- Using GUI:
- Open `VS Code`.
- Go to *File* → *Open Folder* and select in the upcoming window the folder *your_local_path/i2r/*
- Terminal (Linux, macOS):
```bash
cd <your local path>/i2r/
code .
```
- Powershell (Windows)
```bash
```
3. Open the *Terminal* in `VS Code` (*Terminal* &rarr; *New Terminal*). The path in the Terminal should be the one you selected before.
4. Now clone the repository from gitlab by copying the follwing command into the Terminal and press enter. (You are asked to enter your gitlab user name and password.)
```bash
git clone https://git.rwth-aachen.de/introduction-to-robotics-course/introduction-to-robotics-2023.git
```
- If you don't have *git* installed, you can either install it or go to the gitlab repository using the browser and download the source code into the *i2r* folder.
- Information on how to install git can be found for all OS [here](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
5. Now that all the files from the repository are on your local machine, change in the terminal to the folder where the *docker-compose.yml* file is stored.
```bash
cd introduction-to-robotics-2023/00_GettingStarted/docker/i2r/
```
6. Run the following command to spin up the scenario that is defined in the [docker-compose.yml](docker/i2r/docker-compose.yml) file.
```bash
docker compose up
```
4. In the `Docker Desktop` GUI go to the *Containers* tab. You should see now, that there are two containers launched under the group name *i2r*.
7. In the `Docker Desktop` GUI go to the *Containers* tab. You should see now, that there are two containers launched under the group name *i2r*.
- Another option to inspect the containers is using the terminal.
```bash
docker container ls --all
```
## In case of problems
If you run into any issues during the installation process of these softwares, you are welcome to ask me ([Contact Data](https://www.gut.rwth-aachen.de/cms/Geotechnik/Das-Institut/Team/~peawz/Jan-Holzheim/lidx/1/), via mail, phone or in presence).
(Remark: Add notice to Tutorials)
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment