Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
A simple template

Project Title

Simple overview of use/purpose.


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

Getting Started


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


  • 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


Any advise for common problems or issues.

command to run if program contains helper info


Contributors names and contact info

ex. Dominique Pizzie
ex. @DomPizzie

Version History


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


Inspiration, code snippets, etc.

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

Copy link

Brendan-A-Wilson commented Jan 12, 2022

Thanks for this, it's very helpful.

Copy link

kinaneb commented Jan 28, 2022

thank you

Copy link

johanmcollazos commented Jan 29, 2022


Copy link

TracieDiepBautista commented Feb 16, 2022

Great! Thanks for sharing.

Copy link

khaledrakhisi commented Mar 20, 2022

Phenomenal! much appreciated 🍕

Copy link

ghhyc commented Mar 23, 2022

Thank you for sharing.

Copy link

deep-69bits commented Apr 4, 2022


Copy link

devinsylvester commented Apr 11, 2022

So helpful!

Copy link

jaikt commented Apr 15, 2022

soo useful, thq

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

Copy link

fourthborngoose commented Apr 27, 2022

Thank You.

Copy link

mthabafo commented May 8, 2022

Thank you

Copy link

Quantum-Impulse commented Jun 12, 2022

Thank you, you a real one ( : 👍

Copy link

zhangyl334 commented Jun 21, 2022

Thanks very much!

Copy link

ikranjec99 commented Jun 22, 2022

Thank you, finally found great template for my projects 👍

Copy link

EMStokely commented Jul 2, 2022

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

Copy link

ravshan77 commented Jul 7, 2022

thank you!

Copy link

ngandetchuosi commented Jul 24, 2022

Thank you!

Copy link

saidmtanzania commented Aug 3, 2022

Thank you!

Copy link

nxxvaa commented Aug 4, 2022

Thank You!

Copy link

HasanMammadov commented Sep 29, 2022

thank you so much, it was really helpfull

Copy link

Brendon-Schultz commented Oct 9, 2022

Thank you!!!

Copy link

Mihirsur007 commented Oct 13, 2022


Copy link

dimazivan commented Oct 20, 2022

Thanks you so much!!

Copy link

YousefIbrahimismail commented Oct 24, 2022

Thanks for the effort!
Awesome work.

Copy link

Danlinlin commented Oct 29, 2022


Copy link

ChukwudiEkweani commented Nov 20, 2022

Thanks, this is awesome!

Copy link

AnneNK commented Dec 2, 2022

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

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