update of README.md (FireDynamics#57)

* added new markdown files: AUTHORS, DOCKER (move to main directory), CONTRIBUTING
* changed structure of README

Author: LinhWuerzburger

AUTHORS.md

@@ -0,0 +1,22 @@
+## ARTSS Authors
+ARTSS is an open source project, administrated by the Fire Dynamics group of the Forschungszentrum Juelich and run by the *main developer*. Former developers, who are no longer active, are listed under *former developer*. People, who provided fixes and small enhancements are listed under Contributor.
+
+### Supervisor
+* [**Lukas Arnold**](https://www.fz-juelich.de/ias/ias-7/EN/AboutUs/Staff/Current/Arnold_Lukas/main.html): *Contributor* and *Supervisor*
+
+
+### Main developer
+* [**My Linh Würzburger**](https://www.fz-juelich.de/ias/ias-7/EN/AboutUs/Staff/Current/Wuerzburger_My_Linh/main.html?nn=2302136)
+
+### Developer
+* none
+
+
+### Former developer
+* [**Anne Küsters**](https://www.fz-juelich.de/SharedDocs/Personen/IAS/JSC/EN/staff/kuesters_a.html?nn=361682): developer of predecessor JuROr
+
+### Contributor
+The following people have contributed to ARTSS through fixes, small enhancements and many more.
+* Suryanarayana Maddu Kondaiah
+* [**Max Böhler**](https://www.fz-juelich.de/ias/ias-7/EN/AboutUs/Staff/Current/Boehler_Max/_node.html)
+* Sebastian Leifeld

CONTRIBUTING.md

@@ -0,0 +1,3 @@
+## Contributing Guidelines
+
+has to be done yet

docker/README.md renamed to DOCKER.md

@@ -11,6 +11,8 @@
 
 In the directory where the Dockerfile is located run: `docker build -t artss_docker .`
 
+It is not necessary to recreate the Docker image each time. It has to be created initially, and when a change is submitted to the Docker file.
+
 ## Building ARTSS inside the container
 
 Navigate to the ARTSS main directory (where `compile.sh` is located).
@@ -31,6 +33,7 @@ then run `compile.sh [OPTIONS]`. Don't use any GPU flags, since they will not wo
 
 
 ## Running ARTSS
+
 After compiling, ARTSS can be used as usual.
 
 
@@ -44,3 +47,12 @@ After compiling, ARTSS can be used as usual.
 - `docker image rm [tag]` -> Removes Docker image with tag [tag]
 
 More Docker commands: https://docs.docker.com/engine/reference/commandline/cli/
+
+
+## Using Docker with `compile.sh`
+
+The Docker image can be built with `./compile.sh --docker-build`
+
+To build ARTSS inside the container use `--docker-run` or `--docker-run-cpu`. To change the hostname of the Docker add the option `--docker-hostname`.
+
+The Docker commands can be combined with each other.

README.md

@@ -33,8 +33,8 @@ running make. The steps are summarized below.
 git clone https://github.com/FireDynamics/ARTSS.git
 cd ARTSS
 ```
-2. Compiling the code
 
+2. Compiling the code
 ```
 ./compile.sh [OPTIONS]
 ```
@@ -54,7 +54,7 @@ EXAMPLE:
 `./compile.sh -m`
 
 Extra:
-It is also possible to compile ARTSS using a docker file. Instructions and further information can be found in the folder `docker`.
+It is also possible to work with ARTSS by using Docker. Instructions and further information can be found in [DOCKER.md](https://github.com/FireDynamics/ARTSS/tree/master/DOCKER.md).
 
 
 ### Code Structure
@@ -78,9 +78,6 @@ ARTSS
 │   # different tools that make your life easier
 ```
 
-## Authors
-* [**Anne Küsters**](https://www.fz-juelich.de/SharedDocs/Personen/IAS/JSC/EN/staff/kuesters_a.html?nn=361682): *Initial work*
-* [**Lukas Arnold**](https://www.fz-juelich.de/ias/ias-7/EN/AboutUs/Staff/Current/Arnold_Lukas/main.html): *Contributor* and *Supervisor*
-* [**My Linh Würzburger**](https://www.fz-juelich.de/ias/ias-7/EN/AboutUs/Staff/Current/Wuerzburger_My_Linh/main.html?nn=2302136): *Contributor*
-* [**Max Böhler**](https://www.fz-juelich.de/ias/ias-7/EN/AboutUs/Staff/Current/Boehler_Max/_node.html)
-* Suryanarayana Maddu Kondaiah
+### Contributing
+
+We are working constantly on this project, which above all means we are not finished yet: continuous improvements are made, new features are implemented and bugs getting fixed. If you find any errors or you have a suggestions, please feel free to write an issue [here](https://github.com/FireDynamics/ARTSS/issues). If you want to work on the project, please refer to the [contributing guidlines](https://github.com/FireDynamics/ARTSS/tree/master/CONTRIBUTING.md).

docker/Dockerfile

@@ -1,3 +1,5 @@
+### author: Sebastian Leifeld
+
 FROM nvcr.io/hpc/pgi-compilers:ce
 
 RUN apt update