Skip to content

Instantly share code, notes, and snippets.

@jonkirkman
Forked from PurpleBooth/README-Template.md
Last active April 10, 2018 08:15
Show Gist options
  • Save jonkirkman/4c434f4d688bf701671565229e629493 to your computer and use it in GitHub Desktop.
Save jonkirkman/4c434f4d688bf701671565229e629493 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

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

Give an example

Built With

  • Dropwizard - The web framework used
  • Maven - Dependency Management
  • ROME - Used to generate RSS Feeds
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment