From 655b1354c3040b9704a3cd3358f47fa06dd0a823 Mon Sep 17 00:00:00 2001
From: Max SCHMELLER <max.schmeller@tier4.jp>
Date: Thu, 12 Sep 2024 14:15:54 +0900
Subject: [PATCH] docs: add doc build instructions to readme

---
 README.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/README.md b/README.md
index 52b87964a..b6dbdec02 100644
--- a/README.md
+++ b/README.md
@@ -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.
@@ -48,6 +50,13 @@ 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
+python3 -m pip install -U $(curl -fsSL https://raw.githubusercontent.com/autowarefoundation/autoware-github-actions/main/deploy-docs/mkdocs-requirements.txt)
+mkdocs serve
+```
+
 To launch Nebula as a ROS 2 node with default parameters for your sensor model:
 
 ```bash