Create a gist now

Instantly share code, notes, and snippets.

@PurpleBooth /README-Template.md
Last active Nov 6, 2017

What would you like to do?
Download ZIP
A template to make good README.md
Raw
README-Template.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
@Freaky-Brainstorm

Freaky-Brainstorm commented Sep 15, 2016

Thank you
@Villanuevand

Villanuevand commented Sep 28, 2016

Awesome template!
Thanks ... 👏
@GeorgeTaveras1231

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.
@PurpleBooth
Owner

PurpleBooth commented Oct 2, 2016

ooh! good catch, fixed 😄
@ProElbs

ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !
@justinrains

justinrains commented Oct 12, 2016

Thanks!
@LocalMicro

LocalMicro commented Oct 12, 2016

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

dtgoitia commented Oct 16, 2016

Clear and complete. Thanks a lot!
@JosefVitu

JosefVitu commented Oct 17, 2016

Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites
@PurpleBooth
Owner

PurpleBooth commented Oct 17, 2016

Fixed! Thanks 😄
@desfero

desfero commented Oct 20, 2016

thanks :)
@cancinos

cancinos commented Oct 21, 2016

Really nice! Thanks for this guidance!
@surawinfo

surawinfo commented Nov 3, 2016

Thanks!
@fddm

fddm commented Nov 4, 2016

Excellent template! Thanks!
@RCSM

RCSM commented Nov 7, 2016 • edited

Helped a lot, thanks 👍
@andresroberto

andresroberto commented Nov 17, 2016 • edited

Thank you very much for this awesome template! 👍
@Sylvainkossi

Sylvainkossi commented Nov 21, 2016

Excellent!
@lamagnotti

lamagnotti commented Nov 26, 2016

Awesome! Thank you!
@44r0n

44r0n commented Nov 27, 2016

So helpful! Thank you!
@greyfoxamine

greyfoxamine commented Dec 5, 2016

oh my GOD thanks a lot
@bin19906636

bin19906636 commented Dec 16, 2016

Thank you!
@navkelley

navkelley commented Dec 18, 2016

Thank you! This helped me so much.
@afullstopdot

afullstopdot commented Dec 19, 2016

Thank you so much, really helpful for new developers.
@jmoralesce

jmoralesce commented Dec 21, 2016

Thank you!
@rahulsingh8

rahulsingh8 commented Dec 27, 2016

Thanks a ton 👍👍
@anandprajapati1

anandprajapati1 commented Jan 2, 2017

Very useful. Thanks a lot!
@ctlong

ctlong commented Jan 4, 2017

Wonderful, thanks!
@RyanTheMyan

RyanTheMyan commented Jan 5, 2017

Thanks!
@kevinbazira

kevinbazira commented Jan 11, 2017

Thanks a bunch
@awilliams

awilliams commented Jan 13, 2017

Thanks for this
@sicdigital

sicdigital commented Jan 24, 2017

This is really cool. Thanks!
@ldecamp

ldecamp commented Jan 30, 2017

Really cool template. Thanks.
@8eni

8eni commented Feb 7, 2017

great template
@dineshraj01

dineshraj01 commented Feb 8, 2017

Time saviour! thank you !
@calmjohnson

calmjohnson commented Feb 12, 2017

Thanks a lot!
@hsjoihs

hsjoihs commented Feb 13, 2017

Thanks!
@Renato2012

Renato2012 commented Feb 16, 2017

Thank you!
@christinach

christinach commented Feb 17, 2017

Thank you! :)
@nirodg

nirodg commented Feb 19, 2017

Thank you, nice job!
@divakarsingh

divakarsingh commented Feb 19, 2017

Good one, provides quick help.
@Borange

Borange commented Feb 22, 2017

Great job! Thanks!
@reneabreu

reneabreu commented Mar 2, 2017

Thank You! (:
@bnzene

bnzene commented Mar 4, 2017 • edited

Thank you!
@kennorris

kennorris commented Mar 5, 2017

Perfect - thank you!
@JaeDukSeo

JaeDukSeo commented Mar 11, 2017

Thank you!
@WillBeethoven

WillBeethoven commented Mar 14, 2017

Thank you!
@crustafari

crustafari commented Mar 22, 2017

Thank you!!
@tiagodavi70

tiagodavi70 commented Mar 24, 2017

Thanks man!
@AndreMommert

AndreMommert commented Mar 26, 2017

Thank you 👏
@handsfreemc

handsfreemc commented Mar 28, 2017

Appreciate this greatly!
@mrm8488

mrm8488 commented Mar 29, 2017

Thanks
@sinamomken

sinamomken commented Mar 29, 2017

How could I fork it to use later?
@pramod1988

pramod1988 commented Mar 29, 2017

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

sfauch1 commented Mar 29, 2017

Thanks
@guiguiboy

guiguiboy commented Mar 29, 2017

Thanks !
@daquilino

daquilino commented Mar 31, 2017

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

LappleApple commented Apr 1, 2017 • edited

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

Krishna80 commented Apr 4, 2017

thanks a lot nice temp
@Josica

Josica commented Apr 5, 2017

Thank you!
@mskonline

mskonline commented Apr 5, 2017

Thanks...!
@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

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?
@4ToolMaker

4ToolMaker commented Apr 6, 2017

Great, thank you.
@joseluizcoe

joseluizcoe commented Apr 10, 2017

<3 <3 <3
@NelsonTriesCoding

NelsonTriesCoding commented Apr 19, 2017

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

Kayla425 commented Apr 19, 2017

Perfect! Thank you.
@sunnydayw

sunnydayw commented Apr 21, 2017

Love it <3
@VisionYi

VisionYi commented Apr 23, 2017

Thank a lot ! Good template.
@KenrySanchez

KenrySanchez commented Apr 23, 2017

Thank you man. it's very usefull 👍
@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

KikeVen commented May 6, 2017

Thanks !
@brunobc182

brunobc182 commented May 10, 2017

WoW! Nice, thanks!
@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

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

JoseCage commented May 18, 2017

Very useful.. Thanks 👍
@irinadrozdova

irinadrozdova commented May 19, 2017

Oh! Awesome! Thanks!
@mpruessmeier

mpruessmeier commented May 20, 2017

Thank you, very usefull 👍
@mhtsharma948

mhtsharma948 commented May 23, 2017

Really useful!!
Thanks!! :)
@kgb1420

kgb1420 commented May 23, 2017

Beautiful template, thank you.
Typo under Acknowledgements--should be "anyone whose code was used"
@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

TARPTAEYA commented Jun 5, 2017

Great job to benefit beginners
@burakodabas

burakodabas commented Jun 5, 2017

thank you. good tips for beginners
@willrp

willrp commented Jun 7, 2017

Thanks
@afmguedes

afmguedes commented Jun 12, 2017

Amazing, thanks
@LittaPanda

LittaPanda commented Jun 15, 2017

Thanks a lot! You rocks!
@ub

ub commented Jun 17, 2017

Thank you!
@guruglen

guruglen commented Jun 19, 2017

This is Great. Thanks a lot.
@pankajvasnanitech123

pankajvasnanitech123 commented Jun 20, 2017

Very useful Readme template. Thanks.
@urzolaj

urzolaj commented Jun 21, 2017

Succinct! Exactly what I needed.
@eliasfernandez

eliasfernandez commented Jun 22, 2017

cool. thanks
@ppant

ppant commented Jun 24, 2017

Thanks. Very much needed.
@sid226

sid226 commented Jun 25, 2017 • edited

Thanks.
@gavrielCohen

gavrielCohen commented Jun 29, 2017

Thanks :-)
@SalmanTKhan

SalmanTKhan commented Jun 29, 2017

Thanks
@hinell

hinell commented Jun 30, 2017 • edited

Here is more elaborate example
@Saki-hanna

Saki-hanna commented Jul 2, 2017

Thanks
@justinfay

justinfay commented Jul 4, 2017

Thank you.
@kevashcraft

kevashcraft commented Jul 4, 2017

A great template! Thanks 👍
@randercarlos

randercarlos commented Jul 4, 2017

Very good. Save a lot of time.
@simonmilz

simonmilz commented Jul 11, 2017

Thanks
@simondarke

simondarke commented Jul 12, 2017

Thanks :) Really nice template.
@david95thinkcode

david95thinkcode commented Jul 14, 2017

Very useful. Thank you :)
@mauroao

mauroao commented Jul 19, 2017

Thanks !!!!
@tonyfalabella

tonyfalabella commented Jul 19, 2017

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

DracarysBZH commented Jul 20, 2017

Thank you ! Very nice template !
@RobinTHOREL

RobinTHOREL commented Jul 23, 2017

Thank a lot
@otaruMendez

otaruMendez commented Jul 24, 2017

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

estand25 commented Jul 25, 2017

Thank you, this is very helpful
@nvictor

nvictor commented Jul 25, 2017

Thanks!
@TiphaineLAURENT

TiphaineLAURENT commented Jul 26, 2017

Thanks !!
@Chofoteddy

Chofoteddy commented Jul 26, 2017

Thanks, it's very useful! 😃
@PascalKu

PascalKu commented Jul 27, 2017

Thank you sooo much! It's awesome!
@jningtho

jningtho commented Aug 6, 2017

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

arnoldgithub commented Aug 9, 2017

Thank you, it is super useful
@gokulkulkarni1987

gokulkulkarni1987 commented Aug 10, 2017

Thanks a lot, its really helpful
@alireza-nouri

alireza-nouri commented Aug 13, 2017

Thanks a lot
@flakey-bit

flakey-bit commented Aug 14, 2017

Awesome work - thanks a bunch!
@simong33

simong33 commented Aug 15, 2017

Exactly what I was looking for, thanks!
@knapsacklabs

knapsacklabs commented Aug 17, 2017

Thanks
@gmbarroso

gmbarroso commented Aug 18, 2017

Thanks!
@FridaySky

FridaySky commented Aug 19, 2017

This is a great template. Thanks so much! 😄
@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

Osman8a commented Aug 21, 2017

Thank you!!
@belzaaron

belzaaron commented Aug 22, 2017

Good work, Scotty!
@sjgardiner

sjgardiner commented Aug 23, 2017

This is excellent. Many thanks!
@andela-mmichael

andela-mmichael commented Aug 28, 2017

This saved me a couple of minutes. Thanks.
@ch08532

ch08532 commented Aug 31, 2017 • edited

Thanks! Clean and simple
@settermjd

settermjd commented Sep 4, 2017

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

ttaratent commented Sep 5, 2017

wonderful! Thanks.
@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

gerocha commented Sep 13, 2017

thank you very much
@irakligeek

irakligeek commented Sep 15, 2017

Very useful, thanks!
@AlksAlena

AlksAlena commented Sep 21, 2017

Thank you ! 🥇
@3q12

3q12 commented Sep 22, 2017

Thank you
@MashRoofa

MashRoofa commented Sep 22, 2017

Thank you!
@alyssonalvaran

alyssonalvaran commented Sep 26, 2017

Thank you!
@brandonSc

brandonSc commented Sep 27, 2017

Very nice!
@desiraefreedman

desiraefreedman commented Oct 2, 2017

Thank you!
@cynthiayu

cynthiayu commented Oct 2, 2017

Thank you so much! It's so well written and I'm using this for my projects. 💃
@ssw239

ssw239 commented Oct 3, 2017

Thank you for sharing. This helps me a lot.
@kornkaobat

kornkaobat commented Oct 4, 2017

Thank you so much. Without this I couldn't start my README.md professionally.
@byrmcicek

byrmcicek commented Oct 5, 2017 • edited

Thank so much.
@roo-shy

roo-shy commented Oct 8, 2017

Thanks!
@jloures

jloures commented Oct 11, 2017

Thank you!
@Apophus

Apophus commented Oct 13, 2017

Awesome!!
@TylerJOtte

TylerJOtte commented Oct 13, 2017

Very clear and helpful; thank you!
@ashcode1

ashcode1 commented Oct 14, 2017

Great template, thanks for sharing this :)
@Cedric-M

Cedric-M commented Oct 18, 2017

Awesome thank you
@rmfranciacastillo

rmfranciacastillo commented Oct 19, 2017

Thanks for sharing this! It's exactly what I needed
@nex0ma

nex0ma commented Oct 20, 2017

Спасибки!
@pavenkostanislav

pavenkostanislav commented Oct 24, 2017

Спасибо
@sevfitz

sevfitz commented Oct 25, 2017

Excellent! Thanks!
@spencerjpotts

spencerjpotts commented Oct 27, 2017

Cheers bud!
@faithcorinne

faithcorinne commented Oct 28, 2017

Awesome! Just what my group needed. Thanks!
@Jhyeok-lee

Jhyeok-lee commented Nov 3, 2017

Great!
@altcoinrockerxyz

altcoinrockerxyz commented Nov 4, 2017

Thank you!
@lifeF

lifeF commented Nov 6, 2017

thank you!
@Onra

Onra commented Nov 6, 2017

Great ! Thank you :)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment