First attempts to use type hinting

README.md

@@ -16,22 +16,14 @@ The generated computational workload is handled by a [Docker](https://docs.docke
 
 ### **Create network storage**
 
-A shared network space is necessary so that all swarm members have access to all the data. To achieve this a [samba](https://www.samba.org/) share is used.
-``` bash
-# Example: Create a Samba share via Docker
-# More details can be found under https://hub.docker.com/r/dperson/samba/
-username@hostname:~$ sudo mkdir -p /srv/samba/nopaque
-username@hostname:~$ docker run \
-                       --name opaque_storage \
-                       -v /srv/samba/nopaque:/srv/samba/nopaque \
-                       -p 139:139 \
-                       -p 445:445 \
-                       dperson/samba \
-                         -p -r -s "nopaque;/srv/samba/nopaque;no;no;no;nopaque" -u "nopaque;nopaque"
+A shared network space is necessary so that all swarm members have access to all the data. To achieve this a [samba](https://www.samba.org/) share can be used.
 
+You can create a samba share by using [this](https://hub.docker.com/r/dperson/samba/) Docker image.
+
+``` bash
 # Mount the Samba share on all swarm nodes (managers and workers)
 username@hostname:~$ sudo mkdir /mnt/nopaque
-username@hostname:~$ sudo mount --types cifs --options gid=${USER},password=nopaque,uid=${USER},user=nopaque,vers=3.0 //<SAMBA-SERVER-IP>/nopaque /mnt/nopaque
+username@hostname:~$ sudo mount --types cifs --options gid=${USER},password=nopaque,uid=${USER},user=nopaque,vers=3.0 //<SAMBA-SERVER-IP>/<SAMBA-SHARE-NAME> /mnt/nopaque
 ```
 
 ### **Download, configure and build nopaque**
@@ -39,8 +31,8 @@ username@hostname:~$ sudo mount --types cifs --options gid=${USER},password=nopa
 ``` bash
 # Clone the nopaque repository
 username@hostname:~$ git clone https://gitlab.ub.uni-bielefeld.de/sfb1288inf/nopaque.git
-# Create data directories for the database and message queue
-username@hostname:~$ mkdir data/{db,mq}
+# Create data directories
+username@hostname:~$ mkdir data/{db,logs,mq}
 username@hostname:~$ cp db.env.tpl db.env
 username@hostname:~$ cp .env.tpl .env
 # Fill out the variables within these files.
@@ -56,8 +48,6 @@ username@hostname:~$ docker-compose build
 
 ### Start your instance
 ``` bash
-# Create log files
-touch nopaque.log nopaqued.log
 # For background execution add the -d flag
 username@hostname:~$ docker-compose up
 # To scale your app use the following command after starting it normally
@@ -65,5 +55,7 @@ username@hostname:~$ docker-compose -f docker-compose.yml \
                                     -f docker-compose.override.yml
                                     -f docker-compose.scale.yml
                                     up
-                                    -d --no-recreate --scale nopaque=<NUM_INSTANCES>
+                                      -d
+                                      --no-recreate
+                                      --scale nopaque=<NUM_INSTANCES>
 ```