Improving README and pipeline -h (#71)

Improving README and `pipeline -h`: explanation on test, resulting images
machine-shop · Jul 26, 2021 · 85552b2 · 85552b2
1 parent b07df10
commit 85552b2
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -83,12 +83,14 @@ in `./mothra` will run the pipeline on the example data in the folder `/mothra-d
     image2.jpg
     ...
 /test_output
-    image1.jpg (result image for image1.jpg)
+    image1.jpg
     image2.jpg
     ...
     results.csv
 ```
 
+`/test_output` contains the resulting images, i.e. `/test_output/image1.jpg` contains the results of `/mothra-data/image1.jpg`, `/test_output/image2.jpg` has the results of `/mothra-data/image2.jpg`, and so on.
+
  For a larger repository of test data (~15 GB), please check [Wilson et al. (2020)](https://doi.org/10.5281/zenodo.3732132).
 
 ## Miscellaneous

diff --git a/pipeline.py b/pipeline.py
@@ -173,7 +173,8 @@ def _read_filenames_in_folder(folder):
 def main():
     # Assign description to the help doc
     parser = argparse.ArgumentParser(
-        description='Script to automate butterfly wings measurment')
+        description='This is mothra, a software to automate different\
+        measurements on images of Lepidopterae.')
     # Add arguments
     # Plotting
     parser.add_argument('-p', '--plot',