docs: update README

Signed-off-by: ktro2828 <[email protected]>
tier4 · Oct 22, 2024 · de9302e · de9302e
1 parent 59a2078
commit de9302e
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -28,3 +28,11 @@ git clone [email protected]:tier4/t4-devkit.git
 cd t4-devkit
 poetry install
 ```
+
+## Feature supports
+
+|      Feature       | Supported |
+| :----------------: | :-------: |
+| Loading T4 Dataset |    ✅     |
+|   Visualization    |    ✅     |
+|     Evaluation     |           |
diff --git a/docs/index.md b/docs/index.md
@@ -5,3 +5,11 @@
 <div align="center">
     <img src="assets/render_scene.gif" width="800" alt="RENDER SAMPLE"/>
 </div>
+
+## Feature supports
+
+|      Feature       | Supported |
+| :----------------: | :-------: |
+| Loading T4 Dataset |    ✅     |
+|   Visualization    |    ✅     |
+|     Evaluation     |           |
diff --git a/docs/install.md b/docs/install.md
@@ -0,0 +1,14 @@
+## Install via GitHub
+
+```shell
+# e.g) with poetry
+poetry add git+https://github.com/tier4/t4-devkit.git
+```
+
+## Install from source
+
+```shell
+git clone [email protected]:tier4/t4-devkit.git
+cd t4-devkit
+poetry install
+```
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -1,10 +1,12 @@
 site_name: T4 Perception Dataset devkit
 
 nav:
-  - Home: index.md
+  - Home:
+      - T4Devkit: index.md
+      - Installation: install.md
   - Tutorials:
       - Initialization: tutorials/initialize.md
-      - Rendering: tutorials/render.md
+      - Visualization: tutorials/render.md
       - Customization: tutorials/customize.md
   - API:
       - TIER IV: apis/tier4.md