A single template to all my projects README.md

README.md

Project Title

Badges goes here (optional).

(optional)

Short and straightforward project description.

Table of Contents (optional)

• Getting Started
• Usage
• License
• Contributing
• Authors
• Acknowledgments

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Requirements

List of things you need to install the project and how to install them (optional).

• Foo;
• Bar.

installing Foo and Bar

Building

Describe how to build the project and prepare an environment to install the project (step by step):

Explain what to do:

doing

Explain the next step:

doing

Describe what was produced and give examples of output (optional).

Installing

Analogous to building.

Testing

Explain how to run and why (optional) the automated tests for this project.

Break down into end to end tests (optional)

Explain what these tests test and why

example

And coding style tests (optional)

Explain what these tests test and why

example

Deploying

Add additional notes about how to deploy this on a live system.

Usage

Explain how to use the project:

using

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Contributing

We welcome contributions! See CONTRIBUTING.md to learn how to contribute.

Authors

• Thalles Medrado - tysm.

See also the list of contributors who participated in this project.

Acknowledgments

Acknowledgments to softwares, people, frameworks and other things used to produce/inspire/code this project:

• README-Template.md - A gist from PurpleBooth used as base to produce this gist;
• Foo - Explain how it was used;
• Bar - Explain how it was used.