Write a project README

You write the README under README in Settings for the project.

The Owner and Admins can edit and save it for a CMS project, and the Owner, Admins, and Writers can for a Visualizer project. While the number of assigned seats exceeds the contracted number of seats, no role can edit it.

Write and save a README

Write a README that explains what the project holds. You write the text in Markdown.

A project with no README shows a sample that starts with # Project README. The sample is the text already in the Edit tab, so rewrite it to use it.

1. Open Settings for the project.
2. In the left menu, click README.
3. Click Edit. The Edit and Preview tabs appear.
4. Enter the text in the Edit tab.
5. Open the Preview tab and check how it looks. Switching tabs keeps what you entered.
6. Click Save changes.

Once saved, README updated appears, the tabs disappear, and the screen switches to the Preview view.