Skip to content

Instantly share code, notes, and snippets.

@DomPizzie

DomPizzie/README-Template.md

Last active December 25, 2024 19:56
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.
Download ZIP
A simple README.md template
Raw
README-Template.md

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.

@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 •
edited
Loading

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!

@H4ppy-04
Copy link

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

@Tyler-Junek
Copy link

Absolute Chad. Thanks!

@symeok
Copy link

symeok commented Jul 3, 2024

Thanks! Nice job

@zachbakerdev
Copy link

Thanks!

@arezayan
Copy link

arezayan commented Aug 8, 2024

Great

@ApurvaKunkulol
Copy link

This is a great sample for anyone who is just getting their feet wet with adding licenses.
Great sample. Thanks!

@wzeng96
Copy link

wzeng96 commented Oct 16, 2024

Thank you!

@NanaseL
Copy link

NanaseL commented Dec 5, 2024

Thanks!

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