Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
conroy-cheers committed Aug 15, 2021
1 parent de1f4cb commit ba2ce82
Showing 1 changed file with 10 additions and 11 deletions.
21 changes: 10 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,37 +1,36 @@
ArduPilot Software-in-the-Loop Simulator Docker Container
=========================================================

The purpose of this is to run an ArduPilot SITL from within Docker.
The purpose of this container is to run an ArduPilot SITL instance from within Docker.
MAVProxy is included, for Gazebo support.

DockerHub
GitHub Packages Container Registry
---------

A pre-built Docker image is available on DockerHub at:
This repository uses GitHub Actions for CI.

https://hub.docker.com/r/radarku/ardupilot-sitl
To download a pre-built image, simply:

To download it, simply:

`docker pull radarku/ardupilot-sitl`
`docker pull ghcr.io/monashuas/ardupilot-sitl-docker`

and to run it:

`docker run -it --rm -p 5760:5760 radarku/ardupilot-sitl`
`docker run -it --rm -p 5760:5760 ghcr.io/monashuas/ardupilot-sitl-docker`


Quick Start
-----------

If you'd rather build the docker image yourself:

`docker build --tag ardupilot github.com/radarku/ardupilot-sitl-docker`
`docker build --tag ardupilot github.com/MonashUAS/ardupilot-sitl-docker`

You can now use the `--build-arg` option to specify which branch or tag in the ardupilot
repository you'd like to use. Here's an example:

`docker build --tag ardupilot --build-arg COPTER_TAG=Copter-4.0.1 github.com/radarku/ardupilot-sitl-docker`
`docker build --tag ardupilot --build-arg COPTER_TAG=Copter-4.1.0 github.com/radarku/ardupilot-sitl-docker`

If no COPTER_TAG is supplied, the build will use the default defined in the Dockerfile, currently set at Copter-4.0.3
If no COPTER_TAG is supplied, the build will use the default defined in the Dockerfile, currently set at Copter-4.1.0

To run the image:

Expand Down

0 comments on commit ba2ce82

Please sign in to comment.