First things first
An overview of projectsHow to use the project readme Take notes and upload dataTranscribe video and audioFormat your notes and transcriptsFormatting and keyboard shortcutsAdd structured data with fieldsManage participants with People
More articles
Help homeThe basicsFirst things first

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
The basics
Format your notes and transcripts
The basics
Formatting and keyboard shortcuts
Authors
Benjamin Humphrey
Co-founder / CEO
Article info
Last updated 18 November 2020
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
https://platformhelp.gtsb.io/help/project-readme
platformhelp.gtsb.io
crawl=CC-MAIN-2021-10
39301
application/http; msgtype=response
sha1:SR4OHW5FIZ6GUMV4MEN2RM2H6VOADP76
<urn:uuid:a92bbbbd-f0fd-46fb-a311-299b1cc5749d>
2021-03-04T18:27:34Z
35.188.79.208
text/html
sha1:6DQYPWORESYCZSZFG3PYETLDLOPQ2XLC
<urn:uuid:78d8f87a-fe27-479c-80cd-84168daa0b45>
https://platformhelp.gtsb.io/help/project-readme
response
<urn:uuid:55254189-6cdc-4501-99d1-b5c850dbd30e>
isPartOf: CC-MAIN-2021-10
publisher: Common Crawl
description: Wide crawl of the web for February/March 2021
operator: Common Crawl Admin (info@commoncrawl.org)
hostname: ip-10-67-67-241.ec2.internal
software: Apache Nutch 1.18 (modified, https://github.com/commoncrawl/nutch/)
robots: checked via crawler-commons 1.2-SNAPSHOT (https://github.com/crawler-commons/crawler-commons)
format: WARC File Format 1.1
conformsTo: http://iipc.github.io/warc-specifications/specifications/warc-format/warc-1.1/