From 4b05e5f1e30131a4f8b5cee8d894df51d706001f Mon Sep 17 00:00:00 2001 From: Masahiro Kubota <42679530+masahiro-kubota@users.noreply.github.com> Date: Wed, 19 Jun 2024 17:48:10 +0900 Subject: [PATCH] fix: modify readme (#34) * fix: modify readme Signed-off-by: Masahiro Kubota * fix: add newline at end of file to comply with POSIX standards Signed-off-by: Masahiro Kubota --------- Signed-off-by: Masahiro Kubota Co-authored-by: Takagi, Isamu <43976882+isamu-takagi@users.noreply.github.com> --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 1104667..287209e 100644 --- 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 +```