Getting started with Markup

An overview of projectsHow to use the project readmeCreate and update views in projects Take notes and upload dataTranscribe video and audioFormat your notes and transcriptsFormatting and keyboard shortcutsAdd structured data with fieldsCreating a new blank note or insight viewHow to use canvas layoutManage project notifications
More articles
Help homeMarkupGetting started with Markup

How to use the project readme

The project readme is the first thing new visitors will see when they open your project. It’s a great place to describe your project for others, set the context for your research, and write down your plan including goals, hypotheses, timeline, and so on.

Project readmes have the same set of formatting that notes and insights do, which means you can easily insert headings, lists, tables, images, files, and more to describe your project for others. It also supports real time collaboration, so feel free to work with your team on your research plan and see their changes without needing to refresh.

Here are a few ideas for what to cover in the project readme:

  • The research project goals.

  • Your hypotheses or assumptions.

  • Your research plan and timeline.

  • The status of the project.

  • Background on the data set.

Was this article useful?

Related articles


Format your notes and transcripts


Formatting and keyboard shortcuts


Benjamin Humphrey

Co-founder / CEO

Article info

Last updated 24 March 2022
1 min read

Get help

Can’t find what you’re looking for? Search through our articles or contact our support team and get a response within 24 hours.

Get help
Get started, free forever

Start free
A few of our customers

See more customers →