diff --git a/README.md b/README.md index d8a2ec9..51768a4 100644 --- a/README.md +++ b/README.md @@ -18,23 +18,21 @@ is built using [trame][1] by the [kitware][2] team. - When possible it will attempt to utilize the user GPU as much as possible to speedup its computations. -## Usage +## Installing -Usage example with virtual-env creation +Install it from pypi: ```bash -# Setup python environment -python3 -m venv .venv -source .venv/bin/activate -pip install -U pip - -# install application pip install nrtk-explorer +``` + +## Usage +```bash # get some sample data git clone https://github.com/vicentebolea/nrtk_explorer_datasets.git -# Run the application on given dataset (908 images) +# Run the application on given dataset nrtk-explorer --dataset ./nrtk_explorer_datasets/OIRDS_v1_0/oirds.json ``` @@ -58,8 +56,8 @@ cd nrtk-explorer python3 -m venv .venv source .venv/bin/activate pip install -U pip -pip install -e . -pytest +pip install -e '.[dev]' +pytest . ``` [1]: https://trame.readthedocs.io/en/latest/ @@ -70,3 +68,4 @@ pytest 1. Merge `main` to `release` with a _merge commit_. 2. Run "Create Release" workflow with workflow from `release` branch. +3. Merge `release` to `main` with a _merge commit_. diff --git a/screenshot.png b/screenshot.png deleted file mode 100644 index db9bedd..0000000 Binary files a/screenshot.png and /dev/null differ diff --git a/usage.png b/usage.png deleted file mode 100644 index ab8f000..0000000 Binary files a/usage.png and /dev/null differ