Readme files and release notes often contain similar types of information, and you can usually treat them in the same way. The main difference is that readme files provide late-breaking information about a newly released product and release notes provide information about test and beta releases.

Capitalize Readme when you refer to the specific file. Otherwise, you can use readme file or readme.

Microsoft style

For late-breaking information about the mission editor, look in the Readme file in the Editor folder of the game’s root directory.

Look in the Readme file on Disk A for current information.

As far as practical, apply the same rules of style and usage to readme files that you would to all other documentation. Readme files should not contain jargon or overly technical language and they should otherwise conform to Microsoft style.

Readme files are usually HTML files, formatted with bold headings and other style conventions. Use the following guidelines for the front matter of your readme file to ensure that its information will be helpful to its intended reader:

In general, order the readme file with the most important information or information of the most general interest first. List errata and changes to the documentation last. Section numbers are optional.