fix: modify readme (#34)

* fix: modify readme Signed-off-by: Masahiro Kubota <[email protected]> * fix: add newline at end of file to comply with POSIX standards Signed-off-by: Masahiro Kubota <[email protected]> --------- Signed-off-by: Masahiro Kubota <[email protected]> Co-authored-by: Takagi, Isamu <[email protected]>
AutomotiveAIChallenge · Jun 19, 2024 · 4b05e5f · 4b05e5f
1 parent 47d94d7
commit 4b05e5f
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -6,3 +6,17 @@
 
 - [日本語ページ](https://automotiveaichallenge.github.io/aichallenge-documentation-2024/)
 - [English Page](https://automotiveaichallenge.github.io/aichallenge-documentation-2024/en/)
+
+## Deploy
+
+ドキュメントの生成環境をインストールするには以下のコマンドを実行します。
+
+```bash
+pip install -r requirements.txt
+```
+
+ドキュメントをローカル環境で確認したい場合は以下を実行します。
+
+```bash
+mkdocs serve
+```