Create a gist now

Instantly share code, notes, and snippets.

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

  • Hat tip to anyone who's code was used
  • Inspiration
  • etc

Thank you

Awesome template!
Thanks ... πŸ‘

GeorgeTaveras1231 commented Oct 2, 2016 edited

Awesome template!

You have a typo right underneath the installing section. It says Stay what the step will be.

Owner

PurpleBooth commented Oct 2, 2016

ooh! good catch, fixed πŸ˜„

ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !

Thanks!

Thanks, just what I needed to help me write something short and clear.

Clear and complete. Thanks a lot!

Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites

Owner

PurpleBooth commented Oct 17, 2016

Fixed! Thanks πŸ˜„

desfero commented Oct 20, 2016

thanks :)

Really nice! Thanks for this guidance!

Thanks!

fddm commented Nov 4, 2016

Excellent template! Thanks!

RCSM commented Nov 7, 2016 edited

Helped a lot, thanks πŸ‘

andresroberto commented Nov 17, 2016 edited

Thank you very much for this awesome template! πŸ‘

Excellent!

Awesome! Thank you!

44r0n commented Nov 27, 2016

So helpful! Thank you!

oh my GOD thanks a lot

Thank you!

Thank you! This helped me so much.

Thank you so much, really helpful for new developers.

Thank you!

Thanks a ton πŸ‘πŸ‘

Very useful. Thanks a lot!

ctlong commented Jan 4, 2017

Wonderful, thanks!

Thanks!

Thanks a bunch

Thanks for this

This is really cool. Thanks!

ldecamp commented Jan 30, 2017

Really cool template. Thanks.

8eni commented Feb 7, 2017

great template

Time saviour! thank you !

Thanks a lot!

hsjoihs commented Feb 13, 2017

Thanks!

Thank you!

Thank you! :)

nirodg commented Feb 19, 2017

Thank you, nice job!

Good one, provides quick help.

Borange commented Feb 22, 2017

Great job! Thanks!

Thank You! (:

bnzene commented Mar 4, 2017 edited

Thank you!

Perfect - thank you!

Thank you!

Thank you!

Thank you!!

Thanks man!

Thank you πŸ‘

Appreciate this greatly!

mrm8488 commented Mar 29, 2017

Thanks

How could I fork it to use later?

Thank you for creating this wonderful template. This is very helpful for me.

sfauch1 commented Mar 29, 2017

Thanks

Thanks !

Thanks. Great resource.
BTW typo under Installing. 'how' instead of 'have'.

LappleApple commented Apr 1, 2017 edited

+1. Will add this to our/Zalando's own how-to as an alternate resource to this template.

thanks a lot nice temp

Josica commented Apr 5, 2017

Thank you!

Thanks...!

Thanks so much for sharing this template. It is exactly what i need for the current project that I am working on. I will certainly tweak it a little but otherwise this is a good starting point.

I think it would it be interesting to add a changelog section, optional of course. In this section, there would be the additions sorted by releases but also the deprecated features. What do you think?

Great, thank you.

<3 <3 <3

This is exactly what I needed, thank you! <3

Perfect! Thank you.

Love it <3

Thank a lot ! Good template.

Thank you man. it's very usefull πŸ‘

PRO2XY commented Apr 28, 2017

Oh nice! Thanks a lot! Finally I got around to pushing my projects to github, only to realize I didn't quite know how to structure a good readme. Now I can use this as a base and edit the relevant sections for my projects, so that the viewers can see what the repository actually is all about!

Some things that would be good to add (specially for hardware related projects) would be:

  • Screenshots / Images of the set-up (for hardware include schematic / wiring diagram)
  • References (similar to acknowledgements, but may be useful to 'refer' to a particular claim/issue/reasoning.
  • Badges (which I don't know much yet about)

Thanks!

BTW, here's a guide to markdown (as listed under the comments box), the styling system used on github.

KikeVen commented May 6, 2017

Thanks !

WoW! Nice, thanks!

simonpo commented May 16, 2017

Helpful file, thank-you! Unfortunately I am a member of the spelling police, and think you should substitute "whose" for "who's" in the line "Hat tip to anyone who's code was used" (as who's is a contraction of "who is", not the possessive form of "who")

melluru commented May 17, 2017

Thanks for sharing.. it is very structured & presentable. Followed it as a template.. it was like learn and do in one go.

Very useful.. Thanks πŸ‘

Oh! Awesome! Thanks!

Thank you, very usefull πŸ‘

Really useful!!
Thanks!! :)

kgb1420 commented May 23, 2017

Beautiful template, thank you.
Typo under Acknowledgements--should be "anyone whose code was used"

I think you have a wrong wording here:

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

I think you meant how?

Great job to benefit beginners

thank you. good tips for beginners

willrp commented Jun 7, 2017

Thanks

Amazing, thanks

Thanks a lot! You rocks!

ub commented Jun 17, 2017

Thank you!

This is Great. Thanks a lot.

Very useful Readme template. Thanks.

urzolaj commented Jun 21, 2017

Succinct! Exactly what I needed.

cool. thanks

ppant commented Jun 24, 2017

Thanks. Very much needed.

sid226 commented Jun 25, 2017 edited

Thanks.

Thanks :-)

Thanks

hinell commented Jun 30, 2017 edited

Here is more elaborate example

Thanks

Thank you.

A great template! Thanks πŸ‘

Very good. Save a lot of time.

Thanks

Thanks :) Really nice template.

Very useful. Thank you :)

mauroao commented Jul 19, 2017

Thanks !!!!

Very nice. Would you perhaps consider creating a 2nd copy of this in AsciiDoc format?

Thank you ! Very nice template !

Thank a lot

Nice template, possible typo in the Acknowledgements section whose for who's I think you meant.

Thank you, this is very helpful

nvictor commented Jul 25, 2017

Thanks!

Thanks !!

Thanks, it's very useful! πŸ˜ƒ

Thank you sooo much! It's awesome!

jningtho commented Aug 6, 2017

Brilliant! Thank you for putting in so much for time compiling this READ for the noobs :)

Thank you, it is super useful

Thanks a lot, its really helpful

Thanks a lot

Awesome work - thanks a bunch!

Exactly what I was looking for, thanks!

Thanks

Thanks!

This is a great template. Thanks so much! πŸ˜„

Thank you so much, pretty helpful. I have one request can you also share how to call images for better documentation in md file.

Osman8a commented Aug 21, 2017

Thank you!!

Good work, Scotty!

This is excellent. Many thanks!

This saved me a couple of minutes. Thanks.

ch08532 commented Aug 31, 2017 edited

Thanks! Clean and simple

Thank you many times over. This is really helping me out on so many projects.

wonderful! Thanks.

Good to see a great template handy. And very happy to comments almost everyday from the day it drafted.

gerocha commented Sep 13, 2017

thank you very much

Very useful, thanks!

Thank you ! πŸ₯‡

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