Merge pull request #303 from mapswipe/docs

Docs

Author: Matthias-Schaub

docs/source/cli.md

@@ -1,10 +1,15 @@
 # Command Line Interface
 
+THIS DOCUMENT IS OUTDATED: Please use the `--help` flag of the CLI.
+
+---
+
 This document describes how to use the command line interface of MapSwipe Worker.
 
 In our current deployment setup the commands of the MapSwipe Workers CLI are hard-coded in the Docker-Compose File.
 
 You can run these commands also using docker-compose:
+
 ```
 docker-compose run mapswipe_workers mapswipe_workers --help
 ```

docs/source/dev_setup.md

@@ -21,16 +21,20 @@ git checkout dev
 
 ### Configuration
 
-MapSwipe Workers looks for configuration in `~/.config/mapswipe_workers`. (XDG Base Directory Specification is respected). It expects three files:
+MapSwipe Workers looks for configuration in `~/.config/mapswipe_workers`. (XDG Base Directory Specification is respected):
 
+Create the configuration directory:
+`mkdir --parents ~/.config/mapswipe_workers`
+
+MapSwipe Workers expects three files in the configuration directory:
 - `configuration.json`
 - `serviceAccountKey.json`
 - `logging.cfg`
 
 Please refer to the [configuration](configuration.md) and [setup](setup.md) documentation for further details.
 
 In addition the data directory for MapSwipe Workers needs to be created:
-`mkdir --parents .local/share/mapswipe_workers`
+`mkdir --parents ~/.local/share/mapswipe_workers`
 
 
 ### Install MapSwipe Workers Python Package