Updated README for PyPi release

Signed-off-by: Jim Martens <github@2martens.de>

README.md

@@ -1,58 +1,91 @@
 # Masterthesis
-> Short blurb about what your product does.
+> Allows reproduction of results in my masterthesis.
 
 [![Downloads][pypi-downloads]][pypi-url]
 ![License][pypi-license]
 ![Python versions][pypi-python-versions]
 
-One to two paragraph statement about your product and what it does.
+The package supports testing and evaluating SSD and Bayesian SSD. The results
-
+can be visualised.
-![](header.png)
 
 ## Installation
 
 ```sh
 pip install twomartens.masterthesis
+pip install git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI
 ```
 
+The second line is important as Git dependencies cannot be specified in the `setup.py`
+file.
+
 Please refer to [GPU support][tf-gpu-support] for instructions on
 installing the non-Python dependencies for `tensorflow`.
 
+Type the following to create the configuration file and to see the options:
+```sh
+tm-masterthesis config list
+```
+
+Especially the paths have to be set to the correct values.
+
 ## Usage example
 
-A few motivating and useful examples of how your product can be used. 
+```sh
-Spice this up with code blocks and potentially more screenshots.
+tm-masterthesis --help
+```
 
-_For more examples and usage, please refer to the [Wiki][wiki]._
+Lists all available commands. As most commands are nested, it is advisable to 
+request the help at different nesting levels.
+
+```sh
+tm-masterthesis config {get,set,list}
+```
+
+Allows for the modification and retrieval of the configuration values.
+
+```sh
+tm-masterthesis test {ssd,bayesian_ssd} iteration train_iteration
+```
+
+Tests the selected network, using `iteration` as identifier for the test run
+and `train_iteration` as identifier for the training iteration. If the config
+parameter `ssd_test_pretrained` is `True` then the training iteration is
+not relevant. 
+
+```sh
+tm-masterthesis evaluate {ssd,bayesian_ssd} iteration
+```
+
+Runs the evaluation process using the test results identified by `iteration`,
+evaluation results are saved under `iteration` under the evaluation path.
+
+```sh
+tm-masterthesis visualise_metrics {ssd,bayesian_ssd} iteration
+```
+
+Uses the evaluation results stored under `iteration` and visualises
+it. The score JSON and the figure images are stored under `iteration`
+in a `visualise` folder under the output path.
+
+There are more commands but the rest can be very tightly linked to requirements
+in the masterthesis and might therefore not be of interest generally.
 
 ## Development setup
 
-**CHANGE**
+Clone the repository locally. Then execute the following commands inside
-
+the repository:
-Describe how to install all development dependencies and how to run an automated test-suite of some kind. 
-Potentially do this for multiple platforms.
 
 ```sh
-make install
+git submodule init
-npm test
+git submodule update
+pip install -e .
+pip install git+https://github.com/philferriere/cocoapi.git#egg=pycocotools&subdirectory=PythonAPI
 ```
 
 ## Release History
 
-**CHANGE**
-
-* 0.2.1
-    * CHANGE: Update docs (module code remains unchanged)
-* 0.2.0
-    * CHANGE: Remove `setDefaultXYZ()`
-    * ADD: Add `init()`
-* 0.1.1
-    * FIX: Crash when calling `baz()` (Thanks @GenerousContributorName!)
 * 0.1.0
-    * The first proper release
+    * first release
-    * CHANGE: Rename `foo()` to `bar()`
-* 0.0.1
-    * Work in progress
 
 ## Meta
 
@@ -76,5 +109,4 @@ Distributed under the Apache 2.0 license. See ``LICENSE`` for more information.
 [pypi-url]: https://pypi.org/project/twomartens.masterthesis/
 [pypi-downloads]: https://img.shields.io/pypi/dm/twomartens.masterthesis.svg
 [pypi-python-versions]: https://img.shields.io/pypi/pyversions/twomartens.masterthesis.svg
-[wiki]: https://github.com/2martens/masterthesis/wiki
 [tf-gpu-support]: https://www.tensorflow.org/install/gpu

setup.py

@@ -43,7 +43,7 @@ setup(
     license="Apache License 2.0",
     classifiers=[
         "Operating System :: OS Independent",
-        "Development Status :: 1 - Planning",
+        "Development Status :: 2 - Pre-Alpha",
         "License :: OSI Approved :: Apache Software License",
         "Environment :: Console",
         "Intended Audience :: Science/Research",