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
@Freaky-Brainstorm

Thank you

@Villanuevand

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

ooh! good catch, fixed πŸ˜„

@ProElbs
ProElbs commented Oct 4, 2016

Thank you very much, very usefull template !

@justinrains

Thanks!

@LocalMicro

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

@dtgoitia

Clear and complete. Thanks a lot!

@JosefVitu

Thank you for the template!

BTW there's a typo: Prerequisities -> Prerequisites

@PurpleBooth
Owner

Fixed! Thanks πŸ˜„

@desfero
desfero commented Oct 20, 2016

thanks :)

@cancinos

Really nice! Thanks for this guidance!

@surawinfo

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

Excellent!

@lamagnotti

Awesome! Thank you!

@44r0n
44r0n commented Nov 27, 2016

So helpful! Thank you!

@greyfoxamine

oh my GOD thanks a lot

@bin19906636

Thank you!

@navkelley

Thank you! This helped me so much.

@afullstopdot

Thank you so much, really helpful for new developers.

@jmoralesce

Thank you!

@rahulsingh8

Thanks a ton πŸ‘πŸ‘

@anandprajapati1

Very useful. Thanks a lot!

@ctlong
ctlong commented Jan 4, 2017

Wonderful, thanks!

@RyanTheMyan

Thanks!

@kevinbazira

Thanks a bunch

@awilliams

Thanks for this

@sicdigital

This is really cool. Thanks!

@ldecamp
ldecamp commented Jan 30, 2017

Really cool template. Thanks.

@8eni
8eni commented Feb 7, 2017

great template

@dineshraj01

Time saviour! thank you !

@calmjohnson

Thanks a lot!

@hsjoihs
hsjoihs commented Feb 13, 2017

Thanks!

@Renato2012

Thank you!

@christinach

Thank you! :)

@nirodg
nirodg commented Feb 19, 2017

Thank you, nice job!

@divakarsingh

Good one, provides quick help.

@Borange
Borange commented Feb 22, 2017

Great job! Thanks!

@reneabreu

Thank You! (:

@bnzene
bnzene commented Mar 4, 2017 edited

Thank you!

@kennorris

Perfect - thank you!

@JaeDukSeo

Thank you!

@WillBeethoven

Thank you!

@crustafari

Thank you!!

@tiagodavi70

Thanks man!

@AndreMommert

Thank you πŸ‘

@handsfreemc

Appreciate this greatly!

@mrm8488
mrm8488 commented Mar 29, 2017

Thanks

@sinamomken

How could I fork it to use later?

@pramod1988

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

@sfauch1
sfauch1 commented Mar 29, 2017

Thanks

@guiguiboy

Thanks !

@daquilino

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

thanks a lot nice temp

@Josica
Josica commented Apr 5, 2017

Thank you!

@mskonline

Thanks...!

@itsonlybarney

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

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?

@PauloRlopez

Great, thank you.

@joseluizcoe

<3 <3 <3

@NelsonTriesCoding

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

@Kayla425

Perfect! Thank you.

@sunnydayw

Love it <3

@VisionYi

Thank a lot ! Good template.

@KenrySanchez

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

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