readme

Required: No
Type: List of files
Condition: No

Lists files containing information about the project.

Key	Required	Type	Description
path	Yes	String	Path to README file.
directory	No	String	Only supported for README files where path points to a location outside the project root. If the project is copied, the file is moved to this directory relative to the project root and the project file is rewritten to reflect the new layout. If not set, a default of . is assumed. If the project is not copied, the value of directory may be used to show the file at a virtual location in IDEs that support this.

The file type of the README file is inferred from its file extension. The following extension have to be supported by all tool implementations. Other file types may be handled by tools in an implementation-defined way.

• .txt - Plaintext file
• .md - Markdown file

If it is desired to open the README file by default when a project is opened, the highlight key in ui_hints may be used.