diff --git a/README.md b/README.md index c384a11..49d9e44 100644 --- a/README.md +++ b/README.md @@ -28,3 +28,11 @@ git clone git@github.com: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 index a05812d..a933dc4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,3 +5,11 @@
RENDER SAMPLE
+ +## Feature supports + +| Feature | Supported | +| :----------------: | :-------: | +| Loading T4 Dataset | ✅ | +| Visualization | ✅ | +| Evaluation | | diff --git a/docs/install.md b/docs/install.md new file mode 100644 index 0000000..5022c8d --- /dev/null +++ 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 git@github.com:tier4/t4-devkit.git +cd t4-devkit +poetry install +``` diff --git a/mkdocs.yaml b/mkdocs.yaml index f85b96f..eada842 100644 --- 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