Skip to content

Instantly share code, notes, and snippets.

@DomPizzie
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 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.

@HasanMammadov
Copy link

thank you so much, it was really helpfull

@Mihirsur007
Copy link

thanks!

@dimazivan
Copy link

Thanks you so much!!

@YousefIbrahimismail
Copy link

Thanks for the effort!
Awesome work.

@Danlinlin
Copy link

Thanks!

@ChukwudiEkweani
Copy link

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?

@YousefIbrahimismail
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.

demo-gif

Thank you.

@JesusCamarena
Copy link

Cool!

@rohit-56
Copy link

Thank you

@Morinehtar-2222
Copy link

Thank you!

@Ernakh
Copy link

Ernakh commented Feb 8, 2023

Thank you! =)

@Johnny-Klas
Copy link

That's so helpful, thnx a lot!

@maxwellromack
Copy link

Really nice, simple template! Thanks a lot!

@Trivoz
Copy link

Trivoz commented Mar 29, 2023

TYSM

@joaocasimirodev
Copy link

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

@Hey90n
Copy link

Hey90n commented May 12, 2023

How can i add this code to a mod?

@Hey90n
Copy link

Hey90n commented May 12, 2023

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

@MrPaladino
Copy link

Thanks mate!

@BCutkelvin
Copy link

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

@oxynatOr
Copy link

oxynatOr commented Jul 1, 2023

<3 thats a very fair point to start!

thanks a lot!

@AniketKumar06
Copy link

Template Looking Good

@cyan-byte
Copy link

Thanks!

@jseahos
Copy link

jseahos commented Nov 16, 2023

Thanks!

@Omar-Alaa-Elzanaty
Copy link

Thanks!

@Rayenkan
Copy link

Thanks

@PepikVaio
Copy link

Thanks.

@marobakr
Copy link

thanks

@prasgop
Copy link

prasgop commented Feb 26, 2024

Thanks

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