How to Create a Readme in Your Project

A README is a short document attached to your project. You can use it to explain what your project does, give instructions for using it, document your code, and credit the people and resources that helped you. Some competitions, like the Innovation Games, require a README.

Instructions

  1. Open your web project in Web Studio ⎋ and select the Settings toggle in the toolbar.

  2. Find the README box. It accepts standard Markdown ⎋, a simple way to add headings, lists, links, and bold or italic text. As you type in the box on the left, a preview of your formatted README appears on the right.

    The README section of Web Studio's Settings. The Markdown on the left includes "# Solar System Facts" and a "## Credits" list, and the formatted preview on the right shows them as a large heading and a bulleted list.

  3. Select Save settings.

  4. To see your README next to your code, select the Readme toggle in the toolbar. Anyone who opens your project will see the README there, and it opens automatically for projects that have one.

    The Web Studio editor with the Readme panel open on the left, showing the heading "Solar System Facts" and a Credits list, beside the code panes and the live preview.

Markdown Examples

Type thisTo getExample
# My ProjectA large headingMy Project
## CreditsA smaller headingCredits
- Planet facts from NASAA bulleted list item• Planet facts from NASA
**important**Bold textimportant
*emphasis*Italic textemphasis
[NASA](https://www.nasa.gov)A linkNASA ⎋

Here is an example of how Markdown in your README translates to the preview.

Markdown

# My Project

## Credits

- Planet facts from NASA
- Photos from Unsplash

This is **important** and this is *emphasis*.

Learn more at [NASA](https://www.nasa.gov).

Preview

My Project Credits
  • Planet facts from NASA
  • Photos from Unsplash

This is important and this is emphasis.

Learn more at NASA.

What to Include

Keep in mind that when someone clones your project, they get a copy of your README. Updating the README in the original project will not update the README in the copy.