Skip to content

Instantly share code, notes, and snippets.

@adamrobbie
Created July 11, 2012 16:23
Show Gist options
  • Save adamrobbie/3091529 to your computer and use it in GitHub Desktop.
Save adamrobbie/3091529 to your computer and use it in GitHub Desktop.
How to write a good README
Here's what I think it should include:
name of the projects and all sub-modules and libraries (sometimes they are named different and very confusing to new users)
descriptions of all the project, and all sub-modules and libraries
5-line code snippet on how its used (if it's a library)
copyright and licensing information (or "Read LICENSE")
instruction to grab the documentation
instructions to install, configure, and to run the programs
instruction to grab the latest code and detailed instructions to build it (or quick overview and "Read INSTALL")
list of authors or "Read AUTHORS"
instructions to submit bugs, feature requests, submit patches, join mailing list, get announcements, or join the user or dev community in other forms
other contact info (email address, website, company name, address, etc)
a brief history if it's a replacement or a fork of something else
legal notices (crypto stuff)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment