Skip to content

Commit b629da5

Browse files
committed
Update readme and docs
1 parent 06fd47d commit b629da5

File tree

2 files changed

+4
-70
lines changed

2 files changed

+4
-70
lines changed

docs/README.md

Lines changed: 1 addition & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -33,73 +33,7 @@ AirStack is a comprehensive, modular autonomy stack for embodied AI and robotics
3333

3434
## 🔧 Quick Start
3535

36-
### 1. Clone the Repository
37-
38-
```bash
39-
git clone --recursive -j8 [email protected]:castacks/AirStack.git
40-
cd AirStack
41-
```
42-
43-
### 2. Install Docker with NVIDIA Support
44-
45-
Follow [NVIDIA's instructions](https://docs.nvidia.com/ai-enterprise/deployment/vmware/latest/docker.html) for installing Docker with NVIDIA GPU support. Make sure `docker-compose-plugin` is also installed.
46-
47-
### 3. Configure the Repository
48-
49-
```bash
50-
./configure.sh
51-
```
52-
53-
Follow the prompts to complete the initial configuration.
54-
55-
### 4. Get the Docker Images
56-
57-
#### Option 1: Pull from AirLab Registry (Preferred)
58-
59-
```bash
60-
docker login airlab-storage.andrew.cmu.edu:5001
61-
# Enter your andrew id (without @andrew.cmu.edu)
62-
# Enter your andrew password
63-
64-
# Pull the images in the docker compose file
65-
docker compose pull
66-
```
67-
68-
#### Option 2: Build Docker Images From Scratch
69-
70-
```bash
71-
# Download the Ascent Spirit SITL software package
72-
bash simulation/isaac-sim/installation/download_sitl.bash
73-
74-
# Build the images locally (requires NVIDIA NGC access)
75-
docker compose build
76-
```
77-
78-
### 5. Launch the System
79-
80-
```bash
81-
xhost + # allow docker access to X-Server
82-
83-
# Start docker compose services
84-
docker compose up -d
85-
# For multiple robots: docker compose up -d --scale robot=3
86-
```
87-
88-
This will automatically launch and play the Isaac Sim scene specified in the `.env` file.
89-
90-
### 6. Control the Robot
91-
92-
Find the RQT GUI window:
93-
1. Click "Arm and Takeoff"
94-
2. Click "Global Plan" in the trajectory window
95-
96-
You can also switch to "Fixed Trajectory" mode and click "Publish" to follow a predefined trajectory.
97-
98-
### 7. Shutdown
99-
100-
```bash
101-
docker compose down
102-
```
36+
Follow the instructions at https://docs.theairlab.org/main/docs/getting_started/ to set up AirStack on your machine.
10337

10438
## 🏗️ System Architecture
10539

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,13 @@ nav:
4747
- Getting Started: docs/getting_started.md
4848
- Development:
4949
- docs/development/index.md
50-
- docs/development/docker_usage.md
51-
- docs/development/vscode/index.md
52-
- docs/development/project_configuration.md
5350
- AirStack CLI Tool:
5451
- docs/development/airstack-cli/index.md
5552
- docs/development/airstack-cli/extending.md
5653
- docs/development/airstack-cli/architecture.md
54+
- docs/development/docker_usage.md
55+
- docs/development/vscode/index.md
56+
- docs/development/project_configuration.md
5757
- Testing:
5858
- docs/development/testing/index.md
5959
- docs/development/testing/testing_frameworks.md

0 commit comments

Comments
 (0)