Skip to content

Instantly share code, notes, and snippets.

@bradfrost

bradfrost/anatomy-of-a-successful-readme.md

Last active November 11, 2020 20:41
Show Gist options
  • Star 3 You must be signed in to star a gist
  • Fork 2 You must be signed in to fork a gist
  • Save bradfrost/85fd8bd4a8c696554845 to your computer and use it in GitHub Desktop.
Save bradfrost/85fd8bd4a8c696554845 to your computer and use it in GitHub Desktop.
Download ZIP
Anatomy of a successful README
Raw
anatomy-of-a-successful-readme.md

Name of Project [version number] Build Status: Linux

]

[Introduction text about the project. This should be a short summary of the project that explains what it is and why anyone should care about it]

[optional image]

Getting Started

Requirements

[include a bulleted list of any dependencies your project requires. Include links to the dependencies, and additionally links to helpful resources to get up and running with the project's dependencies]

Installation

[installation instructions]

Options

[This is the area to detail all the ]

[optional examples of each option]

Resources

Articles, Tutorials, etc

[External resources that help people use this tool]

Support

[point people to the place where ]

Contributing and Contact

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