Skip to content

Commit

Permalink
docs(README): format style
Browse files Browse the repository at this point in the history
  • Loading branch information
PaulHax committed Oct 14, 2024
1 parent c5df7e7 commit 79aec9a
Showing 1 changed file with 7 additions and 12 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
NRTK EXPLORER
=============
# NRTK EXPLORER

NRTK Explorer is a web application for exploring image datasets. It provides
insights of a image dataset in [COCO][3] format and it evaluate image
Expand All @@ -8,9 +7,7 @@ is built using [trame][1] by the [kitware][2] team.

![nrtk explorer screenshot](https://github.com/user-attachments/assets/85c95836-3490-40ec-813d-e6841c540d51)


Features
--------
## Features

- Explore image datasets in COCO format.
- Apply parametrized image degradation (such as blur) to the images.
Expand All @@ -21,8 +18,7 @@ Features
- When possible it will attempt to utilize the user GPU as much as possible to
speedup its computations.

Usage
----------
## Usage

Usage example with virtual-env creation

Expand All @@ -46,17 +42,15 @@ nrtk-explorer --dataset ./nrtk_explorer_datasets/OIRDS_v1_0/oirds.json

Some COCO image datasets available at: https://github.com/vicentebolea/nrtk_explorer_datasets/

CLI flags and options
---------------------
## CLI flags and options

- `-h|--help` show the help for the command line options, it inherit trame
command line options and flags.
- `--dataset` specify the path to a json file describing a COCO
image dataset. You can specify multiple COCO datasets using a comma `,` as a
separator. Example usage: `nrtk_explorer --dataset /foo-dir/coco.json, ../bar-dir/baz.json`

Contribute to NRTK_EXPLORER
---------------------------
## Contribute to NRTK_EXPLORER

```bash
git clone https://github.com/Kitware/nrtk-explorer.git
Expand All @@ -73,5 +67,6 @@ pytest
[3]: https://cocodataset.org/

### Create release
1. Merge `main` to `release` with a *merge commit*.

1. Merge `main` to `release` with a _merge commit_.
2. Run "Create Release" workflow with workflow from `release` branch.

0 comments on commit 79aec9a

Please sign in to comment.