You are using an unsupported browser. Please update your browser to the latest version on or before July 31, 2020.
close
Home > Project Editor > How do I edit a project's README.md file?
How do I edit a project's README.md file?
print icon

Every project comes with a README.md file which is used to provide helpful information to project users. 

 

The README.md is automatically displayed by default when you:

  • Click View Source to see the project's code.
  • Click Remix to create a copy of the project.

 

Here are some things that you could include in your project's README.md:

  • Instructions on how to use the app.
  • A change log with details about app updates.
  • Credits that show who worked on the project.
  • Images can also be added if you like!

 

 

The README.md uses Markdown, which is a lightweight markup language that allows you to add formatting elements to plaintext text files.

 

How to edit a README.md file:

  1. Open the project editor and make sure that the README.md file is selected in the file tree on the left.
  2. At the top of the right pane, click the Markdown button to reveal edit mode for the file.
  3. Now you can start typing directly in the file.
  4. When you are done, just click the Markdown button again to see what the file will look like when another user views it. 
Got more questions? Check out our Community Forum!
Open 24/7, the forum is where Glitch makers help each other and show off all the rad apps that they have created. It's the friendliest community of coders on the Web!
Feedback
0 out of 2 found this helpful

scroll to top icon