-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: ktro2828 <[email protected]>
- Loading branch information
Showing
2 changed files
with
22 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,21 +6,28 @@ A toolkit to load and operate T4 dataset. | |
<img src="docs/assets/render_scene.gif" width="800" alt="RENDER SAMPLE"/> | ||
</div> | ||
|
||
## Installation | ||
## Getting started | ||
|
||
```shell | ||
git clone [email protected]:tier4/t4_perception_dataset.git | ||
cd t4_perception_dataset/t4-devkit | ||
poetry install | ||
``` | ||
📘 [Documentation](https://tier4.github.io/t4-devkit/) | | ||
⚙️ [Tutorial](https://tier4.github.io/t4-devkit/tutorials/initialize/) | | ||
🧰 [API Reference](https://tier4.github.io/t4-devkit/apis/tier4/) | ||
|
||
> [!NOTE] | ||
> We are planning to publish `t4-devkit` to PyPI in the future release. | ||
### Installation | ||
|
||
#### For users | ||
|
||
## Documents | ||
```shell | ||
# e.g) with poetry | ||
poetry add git+https://github.com/tier4/t4-devkit.git | ||
``` | ||
|
||
Now you can refer to tutorials and API references using `mkdocs` on your local host as follows: | ||
#### For developers | ||
|
||
```shell | ||
mkdocs serve | ||
git clone [email protected]:tier4/t4-devkit.git | ||
cd t4-devkit | ||
poetry install | ||
``` | ||
|
||
> [!NOTE] | ||
> We are planning to publish `t4-devkit` to PyPI in the future release. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
# T4 devkit | ||
|
||
`t4-devkit` is a toolkit to load and operate T4 dataset. | ||
|
||
<div align="center"> | ||
<img src="assets/render_scene.gif" width="800" alt="RENDER SAMPLE"/> | ||
</div> |