Merge branch 'master' of...

Merge branch 'master' of https://gitlab.version.fz-juelich.de/windgassen1/python-ci-template into master

README.md

@@ -15,6 +15,14 @@ Currently, the code is inspected with the following 5 packages:
 - [pytest](https://docs.pytest.org/en/stable/) - Unit testing
 - [coverage](https://coverage.readthedocs.io/en/coverage-5.3/) - Uses pytest to identify how much of your code is covered by test-routines
 
+## Quick Starting guide
+
+1. Fork or Clone the required file into your project. You don't need *src/*, *ci/Docker/* and *README.md*
+2. All all the Files you want to have to *directories.txt*
+3. Build an Docker Image with the [Dockerfile](https://gitlab.version.fz-juelich.de/windgassen1/python-ci-template/-/blob/master/ci/Docker/Dockerfile) and add any packages here that you might need for Unit Testing, etc. You can find the Instuctions under *Packages & Registries - Container Registry*
+4. Replace *gitlab.version.fz-juelich.de:5555/windgassen1/python-ci-template* at the to of the gitlab-ci.yml file with the link to your Image (Use the Copy symbol next to the Image to get the URL).
+5. Add Badges to you Project. The Instruction can be found below.
+
 ## How to use
 
 Initially, the pipeline only tests the python file in the *src/* folder. To insert your existing project or to begin a new one just move/create all .py files in the *src/* folder. All tools the code is tested with get this folder as an argument and will check all python files in the folder. If you want to copy the files over to your repo, you need everything except *README.md* and *src/* for the pipeline to work correctly.