Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
AaronYoung5 committed Nov 21, 2023
1 parent 7c62627 commit 9a03c76
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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:
Expand Down
5 changes: 3 additions & 2 deletions docs/usage/how_to_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9a03c76

Please sign in to comment.