File Management

README file

A text file named README is a standard way of alerting users of your file system to important information.

Where to save

Standard practice is to save the README file in the top level of the folder hierarchy.

What to include

Within the file, give an overview of the file system. The following information will provide helpful context about your shared files:

• Project or organization name
• Creator or manager of the file system (name, title, and contact information)
• Path to files
• Date of last update
• Naming conventions and abbreviation key
• Folder hierarchies

Software and data sharing readme files

Readme files are also important tools for sharing projects, software, code, and data. These files document not just how the files are organized and named but information such as:

• The processes used to create the files
• Their purpose and intended use
• How to run or open the files/code
• Any prerequisites or requirements (software, hardware, licensing)

For more information on how to write a readme for sharing projects, software, code, and data see: 

• Data: Documentation for DataShare (ISU's open access data repository)
• Code/Software: How to write a good README file for Your GitHub project
• Code/Software: How to Write an awesome readme and awesome readme examples for writing better Readmes