From f3ae0507588043fc6c2e2939228b071e34ee198b Mon Sep 17 00:00:00 2001 From: Alex Davies Date: Thu, 19 Sep 2024 11:37:02 -0300 Subject: [PATCH] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 216a121..a7f9cae 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,10 @@ is the drone simulation component, which is the core of the SDK. Spiri Robots run a number of docker containers to achieve their core functionality, we try to keep these essential docker containers in one docker compose file. The -docker compose file you'll find in this repository start an ardupilot-based UAV simulation +docker compose file you'll find in this repository starts an ardupilot-based UAV simulation as well as a ROS master, and mavproxy to tie it together. -To get started you can simply clone this repository and run `docker compose --profile uav-sim`. +To get started you can simply clone this repository and run `docker compose --profile uav-sim up`. Once the simulated UAV is running you can connect to it with QGroundControl or other MavLink compatible software. We expose the UAVs Mavlink conenction on tcp port 5760. @@ -18,6 +18,8 @@ MavLink compatible software. We expose the UAVs Mavlink conenction on tcp port 5 We provide project templates you can use for development that integrate seamlessly into our simulated robots. +These templates are intended to be used with VSCode. + To get started with our project templates install the [copier](https://copier.readthedocs.io/en/stable/) project templating utility.