prepared for release

waikato-datamining · Jul 20, 2021 · 819622f · 819622f
1 parent 9adc5da
commit 819622f
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 5 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -1,8 +1,7 @@
 Changelog
 =========
 
-0.0.1 (????-??-??)
+0.0.1 2021-07-21)
 ------------------
 
 - initial release
-
diff --git a/DESCRIPTION.rst b/DESCRIPTION.rst
@@ -1 +1,5 @@
-Meta-tool that presents frames from a video to object detection frameworks and uses the predictions to determine whether to use a frame or not.
+Meta-tool that presents frames from a video to image analysis frameworks and uses the predictions to determine whether to use a frame or not.
+
+Project page:
+
+https://github.com/waikato-datamining/video-frame-selector
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # video-frame-selector
-Meta-tool that presents frames from a video to object detection frameworks and uses the predictions to determine 
+Meta-tool that presents frames from a video to image analysis frameworks and uses the predictions to determine 
 whether to use a frame or not.
 
+
 ## Installation
 
 * create virtual environment
@@ -16,6 +17,23 @@ whether to use a frame or not.
   ./venv/bin/pip install video-frame-selector
   ```
 
+## Supported formats
+
+* Input
+
+  * webcam
+  * videos
+
+* Image analysis output
+
+  * [ROI CSV](https://github.com/waikato-ufdl/wai-annotations-roi)
+
+* Output
+
+  * JPG files (using frame number as file name)
+  * MJPG video (use either .avi or .mkv as file extension for the container) 
+
+
 ## Command-line options
 
 ```

diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@ def _read(f):
 
 setup(
     name="video-frame-selector",
-    description="Meta-tool that presents frames from a video to object detection frameworks and uses the predictions to determine whether to use a frame or not.",
+    description="Meta-tool that presents frames from a video to image analysis frameworks and uses the predictions to determine whether to use a frame or not.",
     long_description=(
         _read('DESCRIPTION.rst') + b'\n' +
         _read('CHANGES.rst')).decode('utf-8'),