Skip to content

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.

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.

Back to top