README.md

Project title

One short sentence about your project goes here.

Table of Contents

• Project title
  • Table of Contents
  • Introduction
  • Getting Started
    • Prerequisites
    • Installation
  • Documentation
  • Contribution
  • Acknowledgement
  • License
  • Citation
  • Contact

Introduction

Further elaborate on what your project is about and the motivation behind it. Don't write a book but keep it short and simple (max. 5 - 6 sentences).

Getting Started

Prerequisites

• List AND link all necessary dependencies, libraries, modules, helpful links and tutorials in regards to your project.
• Even though you use a dependency management tool like NPM or Pipfile.
• This helps contributors to understand your project's scaffold.
• And your contributors and team members are faster set up with your project.
• If specific hardware or operating system is required, make sure to mention it too.

Installation

1. Write step-by-step instructions on how to set up and install the project.
2. Don't assume that your team members know what to do! So include every little step.
3. Provide instructions for Linux, OSX, and Windows if possible.

Don't forget to include code snippets for easier understanding!

Documentation

Either write your documentation here or provide a link to your extensive documentation website.

If you have a big code base and lots of things to document you should consider using a documentation tool like Sphinx, Mkdocs, Gitbook or any other documentation tool to generate static HTML-files which you then can host on a server.

Contribution

Describe how your team members and contributors can contribute to this project. If you have specific style guideline which should be obeyed be sure to mention it here as well. Also, include a link to your issues tracker if you have one e.g. github.com/project/issues

Acknowledgement

Max Mustermann	John Doe	Zhang San

Now that you have included yourself, your contributors and/or team members above also make sure to list some further inspirational resources and references for your project:

• Some nice article you have read
• An awesome GitHub repository that you have made use of
• A StackOverflow question that has helped you out

License

Provide your license information here and link to your LICENSE.md file.

Citation

Explain how other people can cite your project.

Make sure you provide a BibTeX formatted reference e.g.:

@misc{yourlabel,
 author    = {Name of the authors},
 title     = {Your project's title},
 publisher = {Your publisher},
 year      = {2019},
}

Contact

Put here your contact details so contributors and team members can reach out to you if they have open questions (or want to compliment you).