This is a template for the README of your project. Copy it into your repository as the file README.md, remove this introduction to the template, replace the placeholders marked as [REPLACEME: some content], and add or change whatever else is needed in your context.
The template begins here:
[REPLACEME: badges, remove if you don't show any badges]
[REPLACEME: one sentence to describe the project]
[REPLACEME: some additional paragraphs to describe the project in more detail, what is it purpose, how does it approach it, what is the context of the project, what does it do, e.g. main features]
[REPLACEME: instructions how to install and run the software produced by the project]
[REPLACEME: how to get in contact with the project, contact persons, mailing lists, forums, etc.]
[REPLACEME: links to additional useful information, home page, documentation, etc.]
Contributions are welcome. See the documentation at CONTRIBUTING.md for more details.
This project is licensed under [REPLACEME: Name of license, linked to LICENSE file].
We follow the code of conduct of the OpenRail Association.