Skip to content

Instantly share code, notes, and snippets.

@MaxWhite3790

MaxWhite3790/README-Template.md

Forked from PurpleBooth/README-Template.md
Last active May 31, 2019 02:35
Show Gist options
  • Save MaxWhite3790/8223b784dd916b074231b7a087006d9a to your computer and use it in GitHub Desktop.
Save MaxWhite3790/8223b784dd916b074231b7a087006d9a to your computer and use it in GitHub Desktop.
Download ZIP
A template to make good README.md (Forked by Max White)
Raw
README-Template.md

Project Title

One Paragraph of project description goes here

License: ?

Usage

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

For more examples, please refer to the Documentation

Getting Started

There are many great README templates available on GitHub, however, I didn't find one that really suit my needs so I created this enhanced one. I want to create a README template so amazing that it'll be the last one you ever need.

Here's why:

  • Your time should be focused on creating something amazing. A project that solves a problem and helps others
  • You shouldn't be doing the same tasks over and over like creating a README from scratch
  • You should element DRY principles to the rest of your life 😄

Of course, no one template will serve all projects since your needs may be different. So I'll be adding more in the near future. You may also suggest changes by forking this repo and creating a pull request or opening an issue with the tag.

A list of commonly used resources that I find helpful are listed in the acknowledgements.

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 how 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.

License

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

Authors

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

Contact

Your Name - [email protected]

Acknowledgments

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