DEV Community

Discussion on: How to write a kickass README

Collapse
 
guneyozsan profile image
Guney Ozsan

Nice read thanks!
At minimum I try to include these sections:

  • Title
  • Log line
  • How to install for development
  • How to install for usage/production
  • How to contribute
  • Style guide source
  • License
  • Contact and other links