Skip to content

Instantly share code, notes, and snippets.

Last active April 16, 2024 03:45
Show Gist options
  • Save DomPizzie/7a5ff55ffa9081f2de27c315f5018afc to your computer and use it in GitHub Desktop.
Save DomPizzie/7a5ff55ffa9081f2de27c315f5018afc to your computer and use it in GitHub Desktop.
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

thank you so much, it was really helpfull

Copy link


Copy link

Thanks you so much!!

Copy link

Thanks for the effort!
Awesome work.

Copy link


Copy link

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?

Copy link

YousefIbrahimismail commented Dec 2, 2022

Hi guys, inspired by Dom and other great members of the open-source community.

Appreciate you taking the time to check my Project-README-Template.


Thank you.

Copy link


Copy link

Thank you

Copy link

Thank you!

Copy link

Ernakh commented Feb 8, 2023

Thank you! =)

Copy link

That's so helpful, thnx a lot!

Copy link

Really nice, simple template! Thanks a lot!

Copy link

Trivoz commented Mar 29, 2023


Copy link

Thank you, simple and easy, exactly what I needed.

Copy link

Hey90n commented May 12, 2023

How can i add this code to a mod?

Copy link

Hey90n commented May 12, 2023

And where do i have to put this file and what file?

Copy link

Thanks mate!

Copy link

Thank you @DomPizzie. I was curious if such a standard existed and this is a great one! ;)

Copy link

oxynatOr commented Jul 1, 2023

<3 thats a very fair point to start!

thanks a lot!

Copy link

Template Looking Good

Copy link


Copy link

jseahos commented Nov 16, 2023


Copy link


Copy link


Copy link


Copy link


Copy link

prasgop commented Feb 26, 2024


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