Last Updated: February 25, 2016
·
928
· pluckee

What to include in your README's

when i write a readme for bigger projects i make sure to include a few things

  • a directory/file structure: i use tree a unix command line tool to print out a file structure of the project directory and the place it inside pre & code tags to get a nicely formatted structure

  • my coderwall endorsement button: for obvious reasons

  • a credit/dev team section: just list everyone involved in development