Skip to content

Commit

Permalink
typos in doc
Browse files Browse the repository at this point in the history
  • Loading branch information
paucarre committed May 23, 2021
1 parent fc22c8b commit 8a207f9
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docker/README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# Building image and running container

To build the docker image ( `tsdf-plusplus-ros-catkin-build` ) run:
To build the docker image run:
```bash
./build-ros-image.sh
```

To run the docker image use:
To run the docker image run:
```bash
./run-ros-image.sh
```
Expand All @@ -14,8 +14,7 @@ To run the docker image use:

## Copy workspace from docker machine

If you want to get quicky up and runing, keeping sources on your computer
and using docker as a as a perdictable build system you can run:
To the local development environment up and running quickly using docker run:
```bash
./build-ros-image.sh
./set-me-up.sh
Expand All @@ -28,7 +27,7 @@ This `set-me-up.sh` script will do the following:
- Copy the built workspace to the destination folder of choice
- Stop the container

Note that if you want to change the remote to SSH or your fork you'll need to edit the origin in the cloned repos.
Note that if you want to change the remote to SSH or your fork you'll need to edit the `origin` in the cloned repos.
For instance, in the `tsdf-plusplus` project use something like:
```bash
git remote set-url origin [email protected]:ethz-asl/tsdf-plusplus.git
Expand All @@ -42,9 +41,9 @@ git remote show origin
## Use computer workspace on docker

If you have your workspace locally and want to use the docker machine to build
and/or run nodes, you can use the scrip `docker-develop.sh`.
and/or run nodes, you can use the script `docker-develop.sh`.
This script will discard the sources from the remote repository and instead
use the sources you have locally on your computer that will be mounted
use the sources you have locally on your computer, which will be mounted
on the docker machine.

For example, you can use the following command:
Expand Down

0 comments on commit 8a207f9

Please sign in to comment.