Skip to content

Instantly share code, notes, and snippets.

@regexident

regexident/README-Template.md

Forked from PurpleBooth/README-Template.md
Last active January 23, 2023 22:17
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 2 You must be signed in to fork a gist
  • Save regexident/b08147cecfdcab3efc91 to your computer and use it in GitHub Desktop.
Save regexident/b08147cecfdcab3efc91 to your computer and use it in GitHub Desktop.
Download ZIP
A template to make good README.md
Raw
README-Template.md

Project Title

One Paragraph of project description goes here

Synopsis

At the top of the file there should be a short introduction and/ or overview that explains what the project is. This description should match descriptions added for package managers (Gemspec, package.json, etc.)

Motivation

A short description of the motivation behind the creation and maintenance of the project. This should explain why the project exists.

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.

Prerequisities

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

Give examples

Installing

A step by step series of examples that tell you have to get a development env running

Stay what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Example Use

Show what the library does as concisely as possible, developers should be able to figure out how your project solves their problem by looking at the code example. Make sure the API you are showing off is obvious, and that your code is short and concise.

API Reference

Depending on the size of the project, if it is small and simple enough the reference docs can be added to the README. For medium size to larger projects it is important to at least provide a link to where the API reference docs live.

Running the tests

Explain how to run the automated tests for this system

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

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

Built With

  • Dropwizard - Bla bla bla
  • Maven - Maybe
  • Atom - ergaerga

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

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

Authors

  • John Doe - Initial work - JohnDoe

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

License

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

Acknowledgments

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment