Skip to content
Sanna Frese edited this page Dec 9, 2016 · 14 revisions

Please include a readme for every project.

Contents

In general every readme should include:

  • Description
  • Requirements
  • Plugins
  • Installation
  • Development
  • Standards
  • Build tool instructions
  • License

In some projects, it's also good practice to add more than one:

WordPress

When working with WordPress try to include a readme for every theme (inside theme folder) and every plugin you create (inside plugin folder).

Clone this wiki locally