Skip to content

Instantly share code, notes, and snippets.

@thiagobrabo

thiagobrabo/README-Template.md

Forked from DomPizzie/README-Template.md
Last active April 9, 2024 01:13
Show Gist options
  • Save thiagobrabo/4a37dffa7aec6893a857512824e935a0 to your computer and use it in GitHub Desktop.
Save thiagobrabo/4a37dffa7aec6893a857512824e935a0 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.

Built With

This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

  • Next
  • React
  • Vue
  • Angular
  • Terraform

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