Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
A simple README.md template

Project Title

Simple overview of use/purpose.

Description

An in-depth paragraph about your project and overview of use.

Getting Started

Dependencies

  • Describe any prerequisites, libraries, OS version, etc., needed before installing program.
  • ex. Windows 10

Installing

  • How/where to download your program
  • Any modifications needed to be made to files/folders

Executing program

  • How to run the program
  • Step-by-step bullets
code blocks for commands

Help

Any advise for common problems or issues.

command to run if program contains helper info

Authors

Contributors names and contact info

ex. Dominique Pizzie
ex. @DomPizzie

Version History

License

This project is licensed under the [NAME HERE] License - see the LICENSE.md file for details

Acknowledgments

Inspiration, code snippets, etc.

@maplesyrupman
Copy link

maplesyrupman commented Jan 1, 2022

Gonna use this to write my READMEs when applying for my first job. Simple yet effective, you're a legend for providing this reference

@Brendan-A-Wilson
Copy link

Brendan-A-Wilson commented Jan 12, 2022

Thanks for this, it's very helpful.

@kinaneb
Copy link

kinaneb commented Jan 28, 2022

thank you

@johanmcollazos
Copy link

johanmcollazos commented Jan 29, 2022

Thanks

@TracieDiepBautista
Copy link

TracieDiepBautista commented Feb 16, 2022

Great! Thanks for sharing.

@khaledrakhisi
Copy link

khaledrakhisi commented Mar 20, 2022

Phenomenal! much appreciated 🍕

@ghhyc
Copy link

ghhyc commented Mar 23, 2022

Thank you for sharing.

@deep-69bits
Copy link

deep-69bits commented Apr 4, 2022

Thanks

@devinsylvester
Copy link

devinsylvester commented Apr 11, 2022

So helpful!

@jaikt
Copy link

jaikt commented Apr 15, 2022

soo useful, thq

@opeolluwa
Copy link

opeolluwa commented Apr 25, 2022

Thank you!
I used the template in a CLI project for automating creation of Node.js server application thunderstorm. It's also available on NPM

@fourthborngoose
Copy link

fourthborngoose commented Apr 27, 2022

Thank You.

@mthabafo
Copy link

mthabafo commented May 8, 2022

Thank you

@Quantum-Impulse
Copy link

Quantum-Impulse commented Jun 12, 2022

Thank you, you a real one ( : 👍

@zhangyl334
Copy link

zhangyl334 commented Jun 21, 2022

Thanks very much!

@ikranjec99
Copy link

ikranjec99 commented Jun 22, 2022

Thank you, finally found great template for my projects 👍

@EMStokely
Copy link

EMStokely commented Jul 2, 2022

Thanks. You are the first person to post a normal README.md file on GitHub. lol crazy

@ravshan77
Copy link

ravshan77 commented Jul 7, 2022

thank you!

@ngandetchuosi
Copy link

ngandetchuosi commented Jul 24, 2022

Thank you!

@saidmtanzania
Copy link

saidmtanzania commented Aug 3, 2022

Thank you!

@nxxvaa
Copy link

nxxvaa commented Aug 4, 2022

Thank You!

@HasanMammadov
Copy link

HasanMammadov commented Sep 29, 2022

thank you so much, it was really helpfull

@Brendon-Schultz
Copy link

Brendon-Schultz commented Oct 9, 2022

Thank you!!!

@Mihirsur007
Copy link

Mihirsur007 commented Oct 13, 2022

thanks!

@dimazivan
Copy link

dimazivan commented Oct 20, 2022

Thanks you so much!!

@YousefIbrahimismail
Copy link

YousefIbrahimismail commented Oct 24, 2022

Thanks for the effort!
Awesome work.

@Danlinlin
Copy link

Danlinlin commented Oct 29, 2022

Thanks!

@ChukwudiEkweani
Copy link

ChukwudiEkweani commented Nov 20, 2022

Thanks, this is awesome!

@AnneNK
Copy link

AnneNK commented Dec 2, 2022

This is a very good template when one is starting out or for practice.

@JusOde
Copy link

JusOde commented Dec 2, 2022

Guys am new here, kindly anyone willing to help me catch up with writing a readme file?

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