updated readme

kamikaze · Oct 31, 2022 · cfe6ba2 · cfe6ba2
1 parent acb2a19
commit cfe6ba2
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,16 @@
-# dataset_image_annotator
+# dataset-image-annotator
 Dataset image annotation tool
+
+## Installation
+
+```bash
+python3.11 -m venv venv --upgrade-deps
+source venv/bin/activate
+python -m pip install -U -r requirements_dev.txt
+python -m pip install -U -r requirements.txt
+```
+
+## Running image annotator
+```bash
+python -m dataset_image_annotator --data-root /path/to/dataset/images/
+```