Skip to content

Commit 624246f

Browse files
committed
docs: Add clone and link
1 parent 3990148 commit 624246f

File tree

2 files changed

+36
-4
lines changed

2 files changed

+36
-4
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,18 @@ A repo containing essential ROS2 Humble features for controlling Autonomous Mobi
99
1010
The documentation is hosted on <https://j3soon.github.io/ros2-essentials/>.
1111

12+
## Cloning the Repository
13+
14+
```sh
15+
git clone https://github.com/j3soon/ros2-essentials.git
16+
cd ros2-essentials
17+
```
18+
1219
## Pre-built Workspaces
1320

14-
Pre-built Docker images for each workspace can be pulled by running `docker compose pull` in the corresponding workspace directory.
21+
Pre-built Docker images for each workspace can be pulled by running `docker compose pull` in the corresponding workspace directory. Pulling these images bypasses the time-consuming build process (for both Docker Compose and Dev Containers).
1522

16-
Pulling the pre-built Docker images can bypass the time-consuming building process (for both docker compose & devcontainers).
23+
Click on the following workspaces to navigate to their respective documentation.
1724

1825
| Workspace | amd64 | arm64 | Notes | Maintainer |
1926
|-----------|-------|-------|-------|------------|
@@ -31,14 +38,23 @@ Pulling the pre-built Docker images can bypass the time-consuming building proce
3138
## Building Documentation
3239

3340
```sh
41+
# (Optional) Create and activate python virtual environment
3442
virtualenv venv -p python3
3543
source venv/bin/activate
44+
# Install dependencies and start serving
3645
cd docs
3746
pip install -r requirements.txt
3847
mkdocs serve
3948
# Go to https://127.0.0.1:8000 to view the site.
4049
```
4150

51+
## Linking the README
52+
53+
```sh
54+
rm docs/index.md
55+
ln "${PWD}/README.md" docs/index.md
56+
```
57+
4258
## Acknowledgement
4359

4460
The code is mainly contributed by [Johnson](https://github.com/j3soon), [Yu-Zhong Chen](https://github.com/YuZhong-Chen), [Assume Zhan](https://github.com/Assume-Zhan), [Lam Chon Hang](https://github.com/ClassLongJoe1112), and others. For a full list of contributors, please refer to the [contribution list](https://github.com/j3soon/ros2-essentials/graphs/contributors).

docs/index.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,18 @@ A repo containing essential ROS2 Humble features for controlling Autonomous Mobi
99
1010
The documentation is hosted on <https://j3soon.github.io/ros2-essentials/>.
1111

12+
## Cloning the Repository
13+
14+
```sh
15+
git clone https://github.com/j3soon/ros2-essentials.git
16+
cd ros2-essentials
17+
```
18+
1219
## Pre-built Workspaces
1320

14-
Pre-built Docker images for each workspace can be pulled by running `docker compose pull` in the corresponding workspace directory.
21+
Pre-built Docker images for each workspace can be pulled by running `docker compose pull` in the corresponding workspace directory. Pulling these images bypasses the time-consuming build process (for both Docker Compose and Dev Containers).
1522

16-
Pulling the pre-built Docker images can bypass the time-consuming building process (for both docker compose & devcontainers).
23+
Click on the following workspaces to navigate to their respective documentation.
1724

1825
| Workspace | amd64 | arm64 | Notes | Maintainer |
1926
|-----------|-------|-------|-------|------------|
@@ -31,14 +38,23 @@ Pulling the pre-built Docker images can bypass the time-consuming building proce
3138
## Building Documentation
3239

3340
```sh
41+
# (Optional) Create and activate python virtual environment
3442
virtualenv venv -p python3
3543
source venv/bin/activate
44+
# Install dependencies and start serving
3645
cd docs
3746
pip install -r requirements.txt
3847
mkdocs serve
3948
# Go to https://127.0.0.1:8000 to view the site.
4049
```
4150

51+
## Linking the README
52+
53+
```sh
54+
rm docs/index.md
55+
ln "${PWD}/README.md" docs/index.md
56+
```
57+
4258
## Acknowledgement
4359

4460
The code is mainly contributed by [Johnson](https://github.com/j3soon), [Yu-Zhong Chen](https://github.com/YuZhong-Chen), [Assume Zhan](https://github.com/Assume-Zhan), [Lam Chon Hang](https://github.com/ClassLongJoe1112), and others. For a full list of contributors, please refer to the [contribution list](https://github.com/j3soon/ros2-essentials/graphs/contributors).

0 commit comments

Comments
 (0)