Skip to content

Commit c5df7e7

Browse files
committed
docs(README): add release section, screenshot, remove install section
1 parent 28b3183 commit c5df7e7

File tree

1 file changed

+15
-34
lines changed

1 file changed

+15
-34
lines changed

README.md

Lines changed: 15 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -42,55 +42,36 @@ git clone https://github.com/vicentebolea/nrtk_explorer_datasets.git
4242
nrtk-explorer --dataset ./nrtk_explorer_datasets/OIRDS_v1_0/oirds.json
4343
```
4444

45-
![nrtk explorer usage](https://raw.githubusercontent.com/Kitware/nrtk-explorer/main/usage.png)
45+
![nrtk explorer usage](https://github.com/user-attachments/assets/86a61485-471c-4b94-872e-943cb9da52a1)
4646

47-
Installing
48-
----------
49-
50-
Install it from pypi:
51-
52-
```bash
53-
pip install nrtk-explorer
54-
```
55-
56-
Or, download and install it manually with:
57-
58-
```bash
59-
curl -OL https://github.com/Kitware/nrtk-explorer/archive/refs/heads/main.zip
60-
```
61-
62-
Inside the application source code top directory, install it with:
63-
64-
```
65-
pip install -e .
66-
```
67-
68-
Run the application:
69-
70-
```
71-
nrtk-explorer
72-
```
47+
Some COCO image datasets available at: https://github.com/vicentebolea/nrtk_explorer_datasets/
7348

7449
CLI flags and options
7550
---------------------
7651

7752
- `-h|--help` show the help for the command line options, it inherit trame
7853
command line options and flags.
79-
- `--dataset` specify the directory containing a json file describing a COCO
80-
image dataset. You can specify multiple directory using a comma `,` as a
81-
separator. Example usage: `nrtk_explorer --dataset <dataset dir>`. More
82-
images datasets available at:
83-
https://github.com/vicentebolea/nrtk_explorer_datasets/
54+
- `--dataset` specify the path to a json file describing a COCO
55+
image dataset. You can specify multiple COCO datasets using a comma `,` as a
56+
separator. Example usage: `nrtk_explorer --dataset /foo-dir/coco.json, ../bar-dir/baz.json`
8457

8558
Contribute to NRTK_EXPLORER
8659
---------------------------
8760

88-
Run tests with:
89-
9061
```bash
62+
git clone https://github.com/Kitware/nrtk-explorer.git
63+
cd nrtk-explorer
64+
python3 -m venv .venv
65+
source .venv/bin/activate
66+
pip install -U pip
67+
pip install -e .
9168
pytest
9269
```
9370

9471
[1]: https://trame.readthedocs.io/en/latest/
9572
[2]: https://www.kitware.com/
9673
[3]: https://cocodataset.org/
74+
75+
### Create release
76+
1. Merge `main` to `release` with a *merge commit*.
77+
2. Run "Create Release" workflow with workflow from `release` branch.

0 commit comments

Comments
 (0)