Skip to content

Commit

Permalink
docs: add docs build instructions to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mojomex committed Sep 12, 2024
1 parent 0e5be07 commit 1b2b963
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ Here you will find information about the background of the project, how to insta
- [Contributing](https://tier4.github.io/nebula/contribute)
- [Tutorials](https://tier4.github.io/nebula/tutorials)

To build and serve the documentation locally, see the build steps further below.

## Quick start

Nebula builds with ROS 2 Galactic and Humble.
Expand Down Expand Up @@ -48,6 +50,14 @@ rosdep install --from-paths src --ignore-src -y -r
colcon build --symlink-install --cmake-args -DCMAKE_BUILD_TYPE=Release
```

_(optional)_ To build and serve the documentation, run the following commands in your workspace:

```shell
cd src
pip3 install -r docs/requirements.txt
mkdocs serve
```

To launch Nebula as a ROS 2 node with default parameters for your sensor model:

```bash
Expand Down

0 comments on commit 1b2b963

Please sign in to comment.