Skip to content

Commit 6c68dfc

Browse files
committed
Update getting started about alpha state
1 parent b528d4a commit 6c68dfc

1 file changed

Lines changed: 9 additions & 6 deletions

File tree

docs/getting_started.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Getting Started
22

3+
!!! warning ""
4+
5+
AirStack is currently in ALPHA and only meant for internal usage.
6+
You will need to have an account with AirLab to access the AirLab Docker registry, Nucleus server, and other resources.
7+
The API and functionality are not stable and are subject to change.
8+
9+
310
By the end of this tutorial, you will have the autonomy stack running on your machine.
411

512
## Requirements
@@ -19,13 +26,9 @@ cd AirStack
1926

2027
```bash
2128
./airstack.sh install # installs docker and docker-compose
22-
./airstack.sh setup # this lets you use the `airstack` command
29+
./airstack.sh setup # this lets you use the `airstack` command and sets up your keys
2330
```
2431

25-
## Configure
26-
27-
Run `./configure.sh` and follow the instructions in the prompts to do an initial configuration of the repo.
28-
2932
## Docker Images
3033

3134
Now you have two options on how to proceed. You can build the docker image from scratch or pull the existing image on the airlab docker registry. Building the image from scratch can be useful if you would like to add new dependencies or add new custom functionality. For most users just pulling the existing image will be more conveninent and fast since it doesn't require access to the Nvidia registry.
@@ -49,7 +52,7 @@ The images will be pulled from the server automatically. This might take a while
4952

5053
<details><summary>Option 2: Build Docker Images From Scratch</summary>
5154

52-
1. Download the Ascent Spirit SITL software package by running this script (pip3 is required):
55+
1. Download the Ascent Spirit SITL software package by running this script:
5356

5457
```
5558
cd AirStack/

0 commit comments

Comments
 (0)