Readme Research - Kitch41/Blok-Tech GitHub Wiki

I've researched a few readme's of some popular github pages and this is what i found:

  • Every readme has a setup, usage, contributors, bugs and features page.
  • The readme's are usually there to inform the users of how to operate their github files.

What needs to be in a Readme

My readme has to use the following things:

  • Name
  • Description
  • Photo's of my webpage
  • How to find the webpage (link)
  • How to use my webpage
  • Support (contact me)
  • Authors
  • license
  • Status of the page