Skip to content

Instantly share code, notes, and snippets.

@PurpleBooth

PurpleBooth/README-Template.md

Last active November 9, 2024 20:21
Show Gist options
  • Save PurpleBooth/109311bb0361f32d87a2 to your computer and use it in GitHub Desktop.
Save PurpleBooth/109311bb0361f32d87a2 to your computer and use it in GitHub Desktop.
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 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
@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 •
edited
Loading

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

@DaniCelis25
Copy link

Thank you! About to use that template.

@lucianoambrosini
Copy link

Great job! Thanks a lot!

@NSGholap
Copy link

Thanks

@NSGholap
Copy link

Thanks 😊

@NSGholap
Copy link

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

Thanks! Great job!

@AbdoulkadriBoureima
Copy link

thanks !

@thisbilal
Copy link

Thanks a bunch ! This is exactly what i was looking for.

@BubbaHexinator
Copy link

thank you great work

@Londino
Copy link

Londino commented Feb 17, 2023

Payment is not received please help me

What?

@haram8009
Copy link

thank you great work!

@hayatu4islam
Copy link

Good job!

@plondon-coding
Copy link

Great!

@Zhanylmyrza
Copy link

How to make its look like that? I mean, mine, I can see only raw. inside apiary.apid file

@Zhanylmyrza
Copy link

wanted to make like yours. Templates.md

@Anemia88
Copy link

Un gran logro pa undertux420.org

@warsab
Copy link

warsab commented Jul 11, 2023

Awesome

@Manavv20
Copy link

Manavv20 commented Aug 7, 2023

Very Useful

@ThongchaiDonWanon
Copy link

Oio

@alienat3d
Copy link

Thanks, that’s exactly what I’ve been searching for! 🙌

@Rodolfo-Sampaio
Copy link

Thanks! Great job!

@kinesis19
Copy link

Thanks

@riteshrai24
Copy link

Thanks ! really useful.

@skorpio07
Copy link

outstanding

@ninoslat1
Copy link

Thank you, really useful example

@MenokoOG
Copy link

Thank you!

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