...
README.md
markdown file in its root directory describing the project (see template below)..gitignore
file in its root directory defining files to exclude or to force inclusion (see example below).Code Block | ||||
---|---|---|---|---|
| ||||
# Name of the project and repository content * Short description of the project and repository content. * Provide relative links to demonstrators in this repository. * Provide an overview of the architecture and relation to other projects. * Use [diagrams.net](https://diagrams.net) for your sketches and provide a editable link here. ## Getting started * Describe how to start with this project. ### Prerequisites * Describe requirements to fulfill before starting. ### Installing * Describe how to install required software and this software. ## Tests * Describe how to test this software. ## Deployment * Describe how to deploy this software including required prerequisites and configuration. ## Contributing * Describe how to contribute to this project. At best you link to general [documentation](https://spaces.awi.de/x/bu7FEw) and improve it if necessary. ## Versioning * Describe shortly the versioning approach. ## Authors * List the authors and emails here. ## License We have a BSD-3-Clause license and refer to [documentation](https://spaces.awi.de/x/bu7FEw). ## Acknowledgments * Any acknowledgements? ## Notes * Any additional notes? |
...