4.4 Root folder readme

To create a root folder readme file, use any markdown or text editor (e.g. VS Code, Typora, notepad etc.), open a new file and save it to the root folder for your project, ensuring the file type is .md.

Name your readme file _README.md.

Next, we want to add some content to our _README.md. The purpose of this document is to describe the directory structure of our project. To adequately describe our directory structure we should include:

  • A brief description of the project or purpose of the root folder
  • Date when the root folder was created and who created it
  • Date when the readme file was last updated and who updated it
  • A brief description of the contents of each major folder within the root folder
  • A brief description of file naming conventions used within the directory

To see an example root directory readme file click here.