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

This comment has been minimized.

Copy link

@alehlipka alehlipka commented Sep 15, 2016

Thank you

@Villanuevand

This comment has been minimized.

Copy link

@Villanuevand Villanuevand commented Sep 28, 2016

Awesome template!
Thanks ... πŸ‘

Update:
I made a translated version to spanish from this file.

@GeorgeTaveras1231

This comment has been minimized.

Copy link

@GeorgeTaveras1231 GeorgeTaveras1231 commented Oct 2, 2016

Awesome template!

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

@PurpleBooth

This comment has been minimized.

Copy link
Owner Author

@PurpleBooth PurpleBooth commented Oct 2, 2016

ooh! good catch, fixed πŸ˜„

@ProElbs

This comment has been minimized.

Copy link

@ProElbs ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !

@justinrains

This comment has been minimized.

Copy link

@justinrains justinrains commented Oct 12, 2016

Thanks!

@LocalMicro

This comment has been minimized.

Copy link

@LocalMicro LocalMicro commented Oct 12, 2016

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

@dtgoitia

This comment has been minimized.

Copy link

@dtgoitia dtgoitia commented Oct 16, 2016

Clear and complete. Thanks a lot!

@JosefVitu

This comment has been minimized.

Copy link

@JosefVitu JosefVitu commented Oct 17, 2016

Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites

@PurpleBooth

This comment has been minimized.

Copy link
Owner Author

@PurpleBooth PurpleBooth commented Oct 17, 2016

Fixed! Thanks πŸ˜„

@desfero

This comment has been minimized.

Copy link

@desfero desfero commented Oct 20, 2016

thanks :)

@cancinos

This comment has been minimized.

Copy link

@cancinos cancinos commented Oct 21, 2016

Really nice! Thanks for this guidance!

@surafelml

This comment has been minimized.

Copy link

@surafelml surafelml commented Nov 3, 2016

Thanks!

@f2dmarques

This comment has been minimized.

Copy link

@f2dmarques f2dmarques commented Nov 4, 2016

Excellent template! Thanks!

@rafaelcascalho

This comment has been minimized.

Copy link

@rafaelcascalho rafaelcascalho commented Nov 7, 2016

Helped a lot, thanks πŸ‘

@andresroberto

This comment has been minimized.

Copy link

@andresroberto andresroberto commented Nov 17, 2016

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

@Sylvainkossi

This comment has been minimized.

Copy link

@Sylvainkossi Sylvainkossi commented Nov 21, 2016

Excellent!

@lamagnotti

This comment has been minimized.

Copy link

@lamagnotti lamagnotti commented Nov 26, 2016

Awesome! Thank you!

@44r0n

This comment has been minimized.

Copy link

@44r0n 44r0n commented Nov 27, 2016

So helpful! Thank you!

@greyfoxamine

This comment has been minimized.

Copy link

@greyfoxamine greyfoxamine commented Dec 5, 2016

oh my GOD thanks a lot

@ShawnBin

This comment has been minimized.

Copy link

@ShawnBin ShawnBin commented Dec 16, 2016

Thank you!

@navkelley

This comment has been minimized.

Copy link

@navkelley navkelley commented Dec 18, 2016

Thank you! This helped me so much.

@afullstopdot

This comment has been minimized.

Copy link

@afullstopdot afullstopdot commented Dec 19, 2016

Thank you so much, really helpful for new developers.

@jmoralesce

This comment has been minimized.

Copy link

@jmoralesce jmoralesce commented Dec 21, 2016

Thank you!

@rahulsingh8

This comment has been minimized.

Copy link

@rahulsingh8 rahulsingh8 commented Dec 27, 2016

Thanks a ton πŸ‘πŸ‘

@anandprajapati1

This comment has been minimized.

Copy link

@anandprajapati1 anandprajapati1 commented Jan 2, 2017

Very useful. Thanks a lot!

@ctlong

This comment has been minimized.

Copy link

@ctlong ctlong commented Jan 4, 2017

Wonderful, thanks!

@ryan-mooore

This comment has been minimized.

Copy link

@ryan-mooore ryan-mooore commented Jan 5, 2017

Thanks!

@kevinbazira

This comment has been minimized.

Copy link

@kevinbazira kevinbazira commented Jan 11, 2017

Thanks a bunch

@awilliams

This comment has been minimized.

Copy link

@awilliams awilliams commented Jan 13, 2017

Thanks for this

@sicdigital

This comment has been minimized.

Copy link

@sicdigital sicdigital commented Jan 24, 2017

This is really cool. Thanks!

@ldecamp

This comment has been minimized.

Copy link

@ldecamp ldecamp commented Jan 30, 2017

Really cool template. Thanks.

@8eni

This comment has been minimized.

Copy link

@8eni 8eni commented Feb 7, 2017

great template

@dineshraj01

This comment has been minimized.

Copy link

@dineshraj01 dineshraj01 commented Feb 8, 2017

Time saviour! thank you !

@calmjohnson

This comment has been minimized.

Copy link

@calmjohnson calmjohnson commented Feb 12, 2017

Thanks a lot!

@hsjoihs

This comment has been minimized.

Copy link

@hsjoihs hsjoihs commented Feb 13, 2017

Thanks!

@Renato2012

This comment has been minimized.

Copy link

@Renato2012 Renato2012 commented Feb 16, 2017

Thank you!

@christinach

This comment has been minimized.

Copy link

@christinach christinach commented Feb 17, 2017

Thank you! :)

@nirodg

This comment has been minimized.

Copy link

@nirodg nirodg commented Feb 19, 2017

Thank you, nice job!

@divakarsingh

This comment has been minimized.

Copy link

@divakarsingh divakarsingh commented Feb 19, 2017

Good one, provides quick help.

@Borange

This comment has been minimized.

Copy link

@Borange Borange commented Feb 22, 2017

Great job! Thanks!

@reneabreu

This comment has been minimized.

Copy link

@reneabreu reneabreu commented Mar 2, 2017

Thank You! (:

@bnzene

This comment has been minimized.

Copy link

@bnzene bnzene commented Mar 4, 2017

Thank you!

@quintconnect

This comment has been minimized.

Copy link

@quintconnect quintconnect commented Mar 5, 2017

Perfect - thank you!

@JaeDukSeo

This comment has been minimized.

Copy link

@JaeDukSeo JaeDukSeo commented Mar 11, 2017

Thank you!

@willbchang

This comment has been minimized.

Copy link

@willbchang willbchang commented Mar 14, 2017

Thank you!

@crustafari

This comment has been minimized.

Copy link

@crustafari crustafari commented Mar 22, 2017

Thank you!!

@tiagodavi70

This comment has been minimized.

Copy link

@tiagodavi70 tiagodavi70 commented Mar 24, 2017

Thanks man!

@AndreMommert

This comment has been minimized.

Copy link

@AndreMommert AndreMommert commented Mar 26, 2017

Thank you πŸ‘

@handsfreemc

This comment has been minimized.

Copy link

@handsfreemc handsfreemc commented Mar 28, 2017

Appreciate this greatly!

@mrm8488

This comment has been minimized.

Copy link

@mrm8488 mrm8488 commented Mar 29, 2017

Thanks

@sinamomken

This comment has been minimized.

Copy link

@sinamomken sinamomken commented Mar 29, 2017

How could I fork it to use later?

@pramod1988

This comment has been minimized.

Copy link

@pramod1988 pramod1988 commented Mar 29, 2017

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

@sfauch1

This comment has been minimized.

Copy link

@sfauch1 sfauch1 commented Mar 29, 2017

Thanks

@guiguiboy

This comment has been minimized.

Copy link

@guiguiboy guiguiboy commented Mar 29, 2017

Thanks !

@daquilino

This comment has been minimized.

Copy link

@daquilino daquilino commented Mar 31, 2017

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

@LappleApple

This comment has been minimized.

Copy link

@LappleApple LappleApple commented Apr 1, 2017

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

@Krishna80

This comment has been minimized.

Copy link

@Krishna80 Krishna80 commented Apr 4, 2017

thanks a lot nice temp

@Josica

This comment has been minimized.

Copy link

@Josica Josica commented Apr 5, 2017

Thank you!

@mskonline

This comment has been minimized.

Copy link

@mskonline mskonline commented Apr 5, 2017

Thanks...!

@itsonlybarney

This comment has been minimized.

Copy link

@itsonlybarney itsonlybarney commented Apr 6, 2017

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.

@guiguiboy

This comment has been minimized.

Copy link

@guiguiboy guiguiboy commented Apr 6, 2017

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?

@pau-lo

This comment has been minimized.

Copy link

@pau-lo pau-lo commented Apr 6, 2017

Great, thank you.

@joseluizcoe

This comment has been minimized.

Copy link

@joseluizcoe joseluizcoe commented Apr 10, 2017

<3 <3 <3

@spacewasabi

This comment has been minimized.

Copy link

@spacewasabi spacewasabi commented Apr 19, 2017

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

@Kayla425

This comment has been minimized.

Copy link

@Kayla425 Kayla425 commented Apr 19, 2017

Perfect! Thank you.

@sunnydayw

This comment has been minimized.

Copy link

@sunnydayw sunnydayw commented Apr 21, 2017

Love it <3

@VisionYi

This comment has been minimized.

Copy link

@VisionYi VisionYi commented Apr 23, 2017

Thank a lot ! Good template.

@KenrySanchez

This comment has been minimized.

Copy link

@KenrySanchez KenrySanchez commented Apr 23, 2017

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

@PRO2XY

This comment has been minimized.

Copy link

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

This comment has been minimized.

Copy link

@KikeVen KikeVen commented May 6, 2017

Thanks !

@brunobc182

This comment has been minimized.

Copy link

@brunobc182 brunobc182 commented May 10, 2017

WoW! Nice, thanks!

@simonpo

This comment has been minimized.

Copy link

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

This comment has been minimized.

Copy link

@melluru 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.

@JoseCage

This comment has been minimized.

Copy link

@JoseCage JoseCage commented May 18, 2017

Very useful.. Thanks πŸ‘

@irinadrozdova

This comment has been minimized.

Copy link

@irinadrozdova irinadrozdova commented May 19, 2017

Oh! Awesome! Thanks!

@mpruessmeier

This comment has been minimized.

Copy link

@mpruessmeier mpruessmeier commented May 20, 2017

Thank you, very usefull πŸ‘

@mhtsharma948

This comment has been minimized.

Copy link

@mhtsharma948 mhtsharma948 commented May 23, 2017

Really useful!!
Thanks!! :)

@kgb1420

This comment has been minimized.

Copy link

@kgb1420 kgb1420 commented May 23, 2017

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

@toni-rmc

This comment has been minimized.

Copy link

@toni-rmc toni-rmc commented May 29, 2017

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?

@Tarptaeya

This comment has been minimized.

Copy link

@Tarptaeya Tarptaeya commented Jun 5, 2017

Great job to benefit beginners

@burakodabas

This comment has been minimized.

Copy link

@burakodabas burakodabas commented Jun 5, 2017

thank you. good tips for beginners

@willrp

This comment has been minimized.

Copy link

@willrp willrp commented Jun 7, 2017

Thanks

@afmguedes

This comment has been minimized.

Copy link

@afmguedes afmguedes commented Jun 12, 2017

Amazing, thanks

@LittaPanda

This comment has been minimized.

Copy link

@LittaPanda LittaPanda commented Jun 15, 2017

Thanks a lot! You rocks!

@ub

This comment has been minimized.

Copy link

@ub ub commented Jun 17, 2017

Thank you!

@guruglen

This comment has been minimized.

Copy link

@guruglen guruglen commented Jun 19, 2017

This is Great. Thanks a lot.

@pankajvasnanitech123

This comment has been minimized.

Copy link

@pankajvasnanitech123 pankajvasnanitech123 commented Jun 20, 2017

Very useful Readme template. Thanks.

@urzolaj

This comment has been minimized.

Copy link

@urzolaj urzolaj commented Jun 21, 2017

Succinct! Exactly what I needed.

@eliasfernandez

This comment has been minimized.

Copy link

@eliasfernandez eliasfernandez commented Jun 22, 2017

cool. thanks

@ppant

This comment has been minimized.

Copy link

@ppant ppant commented Jun 24, 2017

Thanks. Very much needed.

@sid226

This comment has been minimized.

Copy link

@sid226 sid226 commented Jun 25, 2017

Thanks.

@gavrielCohen

This comment has been minimized.

Copy link

@gavrielCohen gavrielCohen commented Jun 29, 2017

Thanks :-)

@SalmanTKhan

This comment has been minimized.

Copy link

@SalmanTKhan SalmanTKhan commented Jun 29, 2017

Thanks

@hinell

This comment has been minimized.

Copy link

@hinell hinell commented Jun 30, 2017

Thanks.
I'm also excited to publish my own version of this readme.
It is more elaborate and have dynamic links for quick navigation. Check it out please. 😊

@Saki-hanna

This comment has been minimized.

Copy link

@Saki-hanna Saki-hanna commented Jul 2, 2017

Thanks

@justinfay

This comment has been minimized.

Copy link

@justinfay justinfay commented Jul 4, 2017

Thank you.

@kevashcraft

This comment has been minimized.

Copy link

@kevashcraft kevashcraft commented Jul 4, 2017

A great template! Thanks πŸ‘

@randercarlos

This comment has been minimized.

Copy link

@randercarlos randercarlos commented Jul 4, 2017

Very good. Save a lot of time.

@simonmilz

This comment has been minimized.

Copy link

@simonmilz simonmilz commented Jul 11, 2017

Thanks

@simondarke

This comment has been minimized.

Copy link

@simondarke simondarke commented Jul 12, 2017

Thanks :) Really nice template.

@david95thinkcode

This comment has been minimized.

Copy link

@david95thinkcode david95thinkcode commented Jul 14, 2017

Very useful. Thank you :)

@mauroao

This comment has been minimized.

Copy link

@mauroao mauroao commented Jul 19, 2017

Thanks !!!!

@tonyfalabella

This comment has been minimized.

Copy link

@tonyfalabella tonyfalabella commented Jul 19, 2017

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

@DracarysBZH

This comment has been minimized.

Copy link

@DracarysBZH DracarysBZH commented Jul 20, 2017

Thank you ! Very nice template !

@RobinTHOREL

This comment has been minimized.

Copy link

@RobinTHOREL RobinTHOREL commented Jul 23, 2017

Thank a lot

@otaruMendez

This comment has been minimized.

Copy link

@otaruMendez otaruMendez commented Jul 24, 2017

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

@estand25

This comment has been minimized.

Copy link

@estand25 estand25 commented Jul 25, 2017

Thank you, this is very helpful

@nvictor

This comment has been minimized.

Copy link

@nvictor nvictor commented Jul 25, 2017

Thanks!

@TiphaineLAURENT

This comment has been minimized.

Copy link

@TiphaineLAURENT TiphaineLAURENT commented Jul 26, 2017

Thanks !!

@Chofoteddy

This comment has been minimized.

Copy link

@Chofoteddy Chofoteddy commented Jul 26, 2017

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

@PascalKu

This comment has been minimized.

Copy link

@PascalKu PascalKu commented Jul 27, 2017

Thank you sooo much! It's awesome!

@jningtho

This comment has been minimized.

Copy link

@jningtho jningtho commented Aug 6, 2017

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

@ArnoldGitHub

This comment has been minimized.

Copy link

@ArnoldGitHub ArnoldGitHub commented Aug 9, 2017

Thank you, it is super useful

@gokulkulkarni1987

This comment has been minimized.

Copy link

@gokulkulkarni1987 gokulkulkarni1987 commented Aug 10, 2017

Thanks a lot, its really helpful

@alireza-nouri

This comment has been minimized.

Copy link

@alireza-nouri alireza-nouri commented Aug 13, 2017

Thanks a lot

@flakey-bit

This comment has been minimized.

Copy link

@flakey-bit flakey-bit commented Aug 14, 2017

Awesome work - thanks a bunch!

@simong33

This comment has been minimized.

Copy link

@simong33 simong33 commented Aug 15, 2017

Exactly what I was looking for, thanks!

@knapsacklabs

This comment has been minimized.

Copy link

@knapsacklabs knapsacklabs commented Aug 17, 2017

Thanks

@gmbarroso

This comment has been minimized.

Copy link

@gmbarroso gmbarroso commented Aug 18, 2017

Thanks!

@FriskySaga

This comment has been minimized.

Copy link

@FriskySaga FriskySaga commented Aug 19, 2017

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

@vikasFreelancer1913

This comment has been minimized.

Copy link

@vikasFreelancer1913 vikasFreelancer1913 commented Aug 20, 2017

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

This comment has been minimized.

Copy link

@Osman8a Osman8a commented Aug 21, 2017

Thank you!!

@belzaaron

This comment has been minimized.

Copy link

@belzaaron belzaaron commented Aug 22, 2017

Good work, Scotty!

@sjgardiner

This comment has been minimized.

Copy link

@sjgardiner sjgardiner commented Aug 23, 2017

This is excellent. Many thanks!

@mel-michael

This comment has been minimized.

Copy link

@mel-michael mel-michael commented Aug 28, 2017

This saved me a couple of minutes. Thanks.

@ch08532

This comment has been minimized.

Copy link

@ch08532 ch08532 commented Aug 31, 2017

Thanks! Clean and simple

@settermjd

This comment has been minimized.

Copy link

@settermjd settermjd commented Sep 4, 2017

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

@ttaratent

This comment has been minimized.

Copy link

@ttaratent ttaratent commented Sep 5, 2017

wonderful! Thanks.

@pravynandas

This comment has been minimized.

Copy link

@pravynandas pravynandas commented Sep 5, 2017

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

@gerocha

This comment has been minimized.

Copy link

@gerocha gerocha commented Sep 13, 2017

thank you very much

@irakligeek

This comment has been minimized.

Copy link

@irakligeek irakligeek commented Sep 15, 2017

Very useful, thanks!

@AlksAlena

This comment has been minimized.

Copy link

@AlksAlena AlksAlena commented Sep 21, 2017

Thank you ! πŸ₯‡

@always0ne

This comment has been minimized.