README Template

readme-template.md

README Template

One-sentence project description.

Table of Contents

• About the Project
  • Built With
• Getting Started
  • Prerequisites
  • Installation
• Usage
• Roadmap
• Contributing
• Versioning
• Tests
  • End-to-end Tests
  • Coding Style Tests
• License
• Authors
• Acknowledgements

About The Project

Project description.

Built With

List major frameworks. Leave add-ons/plugins for acknowledgements section.

Getting Started

Instructions on setting up project locally.

Prerequisites

Things needed to use the software and how to install them.

Installation

How to install project.

Usage

Show few examples of how project can be used. Screenshots, code examples and demos work well. May also link to more resources.

For more examples, please refer to the Documentation

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Overview of contribution guidelines.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Can include links to:

• Detailed Contribution Guidelines.
• Issue Template
• Pull Request Template

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Tests

How to run automated tests for this project.

End-to-End Tests

What these tests test and why.

Example

Coding Style Tests

What these tests test and why.

Example

License

Distributed under the MIT License. See LICENSE for more information.

Authors

Your Name - @your_twitter - email@example.com

Project Link: https://github.com/your_username/repo_name

Acknowledgements

Acknowledgements go here.