Skip to content

Commit d3ba72c

Browse files
authored
chore: update readme (#129)
1 parent 44cb88b commit d3ba72c

File tree

1 file changed

+11
-18
lines changed

1 file changed

+11
-18
lines changed

README.md

Lines changed: 11 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -58,29 +58,28 @@ For a deeper understanding, refer to the following documents:
5858

5959
## Quick Start
6060

61-
**Note:** For quick startup and verification, only the CPU-based image
62-
(simulation planning module) is provided. The full GPU-dependent tutorial will
63-
be released later. We recommend starting with the CPU image because the GPU
64-
image is large and has complex dependencies, which may not be suitable for
65-
beginners.
61+
We recommend using the **CPU version for quick experience and verification**.
62+
- The CPU-based image is smaller and has simpler dependencies, making it suitable for beginners and basic planning modules.
63+
- The **GPU version** has a larger image size and more complex dependencies, and is more appropriate for **deep development scenarios** such as deep learning and GPU-accelerated workflows.
64+
65+
---
6666

6767
### 1. Install Deployment Tool
6868

6969
```bash
7070
pip install whl-deploy
7171
```
7272

73-
### 2. Setup Host Environment
73+
`whl-deploy` is a tool that simplifies deployment of WheelOS environments using **bundle packages** or **`manifest.yaml`**. For detailed usage, ref [docs](https://github.com/wheelos-tools/whl-deploy/blob/main/README.md)
74+
75+
---
7476

75-
Run the following scripts to prepare your host machine. These steps will:
77+
### 2. Setup Host Environment
7678

77-
1. Install Docker (checks if already installed)
78-
2. [skip] Install NVIDIA Container Toolkit (checks if already installed, depends
79-
on Docker)
80-
3. [skip] Perform host system configurations
79+
Run the following to prepare your host machine:
8180

8281
```bash
83-
whl-deploy setup docker
82+
whl-deploy run
8483
```
8584

8685
### 3. Start Docker Container
@@ -97,12 +96,6 @@ To enter the running container environment in subsequent sessions:
9796
bash docker/scripts/dev_into.sh
9897
```
9998

100-
Set environment variables:
101-
102-
```bash
103-
source cyber/setup.bash
104-
```
105-
10699
### 4. Build Apollo
107100

108101
To build the entire Apollo project:

0 commit comments

Comments
 (0)