Skip to content

Instantly share code, notes, and snippets.

@mikeo85
Forked from DomPizzie/README-Template.md
Last active February 9, 2021 15:51
Show Gist options
  • Save mikeo85/5b6e1a15157cbb1d72a781cd3b0d5baa to your computer and use it in GitHub Desktop.
Save mikeo85/5b6e1a15157cbb1d72a781cd3b0d5baa to your computer and use it in GitHub Desktop.
A simple README.md template

Project Title

One-line summary of project.
Or just put some ascii art here

Description

Paragraph. (Omit heading and paragraph if one-line summary above is enough.)

Repo URL: URL

Features

The main features include:

  • TBD

Prerequisites / Dependencies

  • As needed

Installation and Setup

  • Clone the repo into a working folder.
  • Any other preparatory steps

Execution

  • How to run the program
  • Step-by-step bullets
code blocks for commands

Post-Execution

  • As needed

Additional Notes

  • TBD

Todo

  • TBD

Metadata

Contributors

License: {TYPE: MIT, GPL, etc.} * * * * Note: Here's a quick summary of various open source licenses.

Version History

Acknowledgments

Inspiration, code snippets, etc.

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