Skip to content

Instantly share code, notes, and snippets.

@moafred

moafred/Readme-template.md

Last active February 3, 2017 09:32
Show Gist options
  • Save moafred/188bc71eda9b37fb986dabbefe301beb to your computer and use it in GitHub Desktop.
Save moafred/188bc71eda9b37fb986dabbefe301beb to your computer and use it in GitHub Desktop.
Download ZIP
Raw
Readme-template.md

Project Title

For who, and what for. Not the implementation.

Getting Started

If you want to say something about the local development or production.

Prerequisites

What things you need to install the software and how to install them

brew install whatever

Installing

Install this

this

And that

that

Examples (optional)

If you want to do that

Do like this

Running the tests

Explain how to run the automated tests for this system

like this

Deployment (optional for lib)

How to deploy it.

Architecture

Which architecture pattern and tools you use to build the projet

Acknowledgments (optional)

  • You have to know this if you want achieve that
  • You may use this project for that but you will need to
  • etc

Contributing (optional)

Create a pull request and [...]

Versioning (optional)

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

Authors (optional, commits can help with that but more information may be welcome)

  • John Snow - Help but die, again.

License (optional)

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment