Create a README file

About this activity

Objectives:

• Start creating a README file for your own project
• Document how files and folders are structured
• Simplify collaboration with others

Create a README file

1. Consider what purpose this README file will serve
2. Consider at what level you want to create a README file. It can be at the root of your project, in a specific folder or in a specific file
3. Use a README template to get started. You can find templates here
4. Go back to the data organisation module to get inspiration for naming conventions for your files and folders

More guidance can be found in the README module and on SciLifeLab RDM Guidelines