Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
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 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.

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

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc
@Sikandarkhan
Copy link

Sikandarkhan commented Jan 10, 2021

Simple and contentful.

@Sikandarkhan
Copy link

Sikandarkhan commented Jan 10, 2021

Simple and contentful.

@papaqui
Copy link

papaqui commented Feb 5, 2021

Gracias! Very useful.

@irSilviana
Copy link

irSilviana commented Feb 8, 2021

Thank you, it's a clear explanation and so useful :)

@irSilviana
Copy link

irSilviana commented Feb 8, 2021

Thank you, it's a clear explanation and so useful :)

@samuel-nwankwo
Copy link

samuel-nwankwo commented Feb 24, 2021

Thank you, this is great!

@Karosuo
Copy link

Karosuo commented Feb 26, 2021

Great format, thank you! :D

@GruelingPine185
Copy link

GruelingPine185 commented Mar 23, 2021

This was very nice... solid 20 second scroll to write this lol

@Otromascomotu
Copy link

Otromascomotu commented Apr 7, 2021

Hi Purp! Excellent contribution! I liked...

@ardaorkin
Copy link

ardaorkin commented May 3, 2021

Awesome!!! Appreciate!

@ardaorkin
Copy link

ardaorkin commented May 3, 2021

Awesome!!! Appreciate!

@karma-systems
Copy link

karma-systems commented Dec 12, 2021

Great, Many thanks.

@sajith-rahim
Copy link

sajith-rahim commented Jan 5, 2022

Thank You :)

@yuis-ice
Copy link

yuis-ice commented Feb 2, 2022

One of the greatest readme doc. Thanks mate.

@vonshirco
Copy link

vonshirco commented Mar 2, 2022

Very useful, thanks🤝🏾

@MekongDelta-mind
Copy link

MekongDelta-mind commented Mar 3, 2022

There are many templates out there. I found your's the simplest. This is the most to the point template without any flashy badges.

@IsaacNdala
Copy link

IsaacNdala commented Mar 5, 2022

Great Job! Thank you so much!

@Gizachew29
Copy link

Gizachew29 commented May 5, 2022

Great Readme, Thanks.

@Soohan-Park
Copy link

Soohan-Park commented May 30, 2022

Perfect :)

@choikangjae
Copy link

choikangjae commented Jun 22, 2022

Outstanding Thanks!
It didn't just give me how to write down the README but also give me enlightening what I even don't know about my projects need.

@rodaw92
Copy link

rodaw92 commented Jul 2, 2022

Amazing, Thank you

@rami-HP
Copy link

rami-HP commented Jul 6, 2022

Thank you 👍

@ilovecopy
Copy link

ilovecopy commented Jul 18, 2022

If I have a screenshot or picture about my project,Which paragraph should I put the picture in the readme?

@DaniCelis25
Copy link

DaniCelis25 commented Jul 28, 2022

Thank you! About to use that template.

@lucianoambrosini
Copy link

lucianoambrosini commented Aug 6, 2022

Great job! Thanks a lot!

@NSGholap
Copy link

NSGholap commented Sep 23, 2022

Thanks

@NSGholap
Copy link

NSGholap commented Sep 23, 2022

Thanks 😊

@NSGholap
Copy link

NSGholap commented Sep 23, 2022

Thanks you search me a my way so very very Thanks

@sdn0303
Copy link

sdn0303 commented Oct 4, 2022

Great job! thank you so much 🙏

@Cuisine-De-Lapin
Copy link

Cuisine-De-Lapin commented Nov 9, 2022

Thanks! Great job!

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