Skip to content

Instantly share code, notes, and snippets.

@therbta

therbta/README-Template.md

Forked from DomPizzie/README-Template.md
Created April 7, 2022 03:18
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save therbta/5b4b37417d4d71fdf3e37ef55236ea7a to your computer and use it in GitHub Desktop.
Save therbta/5b4b37417d4d71fdf3e37ef55236ea7a 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.

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