From 9a03c76c5e15fc3abf4a0a5c741b759f37f6c143 Mon Sep 17 00:00:00 2001 From: AaronYoung5 Date: Tue, 21 Nov 2023 15:58:36 -0500 Subject: [PATCH] Updated docs --- docs/README.md | 4 ++-- docs/usage/how_to_run.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 0b78f591..24a7286d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -58,7 +58,7 @@ WARN[0000] The "DISPLAY" variable is not set. Defaulting to a blank string. ### Launch the simulation -The first time you start up the chrono service, it will need to build the image. This may take a while. +The first time you start up the chrono service, it will need to build/pull the image. This may take a while. ```bash $ atk dev -ua -s chrono --optionals gpus vnc @@ -80,7 +80,7 @@ Initialized ChROSInterface: chrono_ros_node. ### Build and run the autonomy stack -The first time you start up the dev service, it will need to build the image. This may take a while. +The first time you start up the dev service, it will need to build/pull the image. This may take a while. > [!NOTE] > The very first time you run `colcon build`, you may need to install the `bluespace_ai_xsens_ros_mti_driver` library. To do that, run the following: diff --git a/docs/usage/how_to_run.md b/docs/usage/how_to_run.md index 997a7e3a..eb7ed8fe 100644 --- a/docs/usage/how_to_run.md +++ b/docs/usage/how_to_run.md @@ -18,9 +18,10 @@ This is a quick review of some `atk` concepts and how to do some basic operation ### Building the services -Explicitly building the services is not actually required. When you run the `up` command for the first time, the images will also be built. +> [!TIP] +> Explicitly building the services is not actually required. We have pre-built images on [Docker Hub](https://hub.docker.com/repository/docker/uwsbel/art/general) which will be pulled when you use the `up` command. -At the moment, there are three services: `vnc`, `chrono`, and `dev`. We can build all of these in one go: +Let's say you want to build three services: `vnc`, `chrono`, and `dev`. We can build all of these in one go: ```bash $ atk dev -b -s vnc chrono dev