Skip to content

Instantly share code, notes, and snippets.

@evolve2k

evolve2k/gist:1077086

Created July 12, 2011 00:05
Show Gist options
  • Star 2 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save evolve2k/1077086 to your computer and use it in GitHub Desktop.
Save evolve2k/1077086 to your computer and use it in GitHub Desktop.
Download ZIP
What makes a good README
Raw
gistfile1.txt
Notes from 'Xavier Shay's talk' - What makes a good README file (RORO 2010 Melbourne)
Use Symantic versioning (Major.Minor.Patch)
What
----
What prob u solving
How
---
Gem, plugin ?
Why
---
Compares to other code
Developers
----------
Where should I start reading , from there comments take over.
Proprietary code
Learn the code base
How to get dev environment setup
Status
------
Major forks
Major plans
If it's a Fork
Top of readme, say why different
Check out the Readme's for
kronic - https://github.com/xaviershay/kronic
candy gem - https://github.com/SFEley/candy
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment