Skip to content

Instantly share code, notes, and snippets.

@JoniWeiss
Forked from PurpleBooth/README-Template.md
Last active April 11, 2017 21:41
Show Gist options
  • Save JoniWeiss/99fec9469d50ae98602393ec2fcaabb1 to your computer and use it in GitHub Desktop.
Save JoniWeiss/99fec9469d50ae98602393ec2fcaabb1 to your computer and use it in GitHub Desktop.
A template to make good README.md

Project Title

One Paragraph of project description goes here

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.

Prerequisites

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

Say 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

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 - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds

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

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

License

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

Acknowledgments

ReadMe format from Billie Thompson:

  • Billie Thompson - Initial work - PurpleBooth
  • 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