Skip to content

Commit

Permalink
docker: add usage instructions to BUILD.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Burka authored and rmackay9 committed May 28, 2024
1 parent dcf41cf commit c027c2e
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,27 @@ list some basic and more used commands as example.

Also, take a look on the [Advanced section](#advanced-usage) below.

### Using Docker ###

A docker environment is provided which may be helpful for building in a clean
environment and avoiding modification of the host environment.

To build the docker image (should only need to be done once), run:

```bash
docker build --rm -t ardupilot-dev .
```

To build inside the container, prefix your `waf` commands, e.g.:

```bash
docker run --rm -it -v $PWD:/ardupilot ardupilot-dev ./waf configure --board=sitl
docker run --rm -it -v $PWD:/ardupilot ardupilot-dev ./waf copter
```

Alternatively, simply run `docker run --rm -it -v $PWD:/ardupilot ardupilot-dev` to
start a `bash` shell in which you can run other commands from this document.

## Advanced usage ##

This section contains some explanations on how the Waf build system works
Expand Down

0 comments on commit c027c2e

Please sign in to comment.