Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
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.

@MikeC0xl0ng

This comment has been minimized.

Copy link

@MikeC0xl0ng MikeC0xl0ng commented Jun 1, 2021

Found it useful, thanx

@gazzar97

This comment has been minimized.

Copy link

@gazzar97 gazzar97 commented Jun 11, 2021

a good template to start with thanks for sharing it with us

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