World map

 

BM

World 5: Teamwork

Write a great README

You will learn: what a great README says, and in what order.

The problem

Practice repo — not a real website
sam-builds / quiz-game
main
README.md

quiz

stuff

Sam’s quiz game might be fun. But the README just says “stuff”. What is it? How do you play? Most visitors leave right here.

Try it

A great README: The front-door file of a repo. It says what the project is and how to start. answers five questions. Put them in a good order.

First question at the top. Put these in order. Use the arrows, or drag.

  • Why is it useful?
  • What does the project do?
  • Who keeps it going?
  • How do I get started?
  • Where can I get help?

Try it

Fix Sam’s README. Add a line that says what the game does. Then add a Get started section with a command in backticks.

Add a short description, a ## Get started heading and one command in backticks.

Preview

Quiz Game

0 of 3 goals done

Predict

Which first line helps a stranger most?

Check

Good README habit, or needs work? Swipe each one.

Swipe right for good, left for needs work. Or use the buttons.

1 / 4

Show the install command in a code block

Try it

Real mission, if you like: give your diary repo on GitHub a great README. Then check it here.

Check it on GitHub

Your username is sent only to api.github.com.

  • Your diary repo has a README.mdNot checked yet

You did it!

You can now write a README that welcomes strangers.

Go deeper (optional)

GitHub shows the README from .github/, the top folder or docs/. It checks them in that order. Add pictures with alt text, so everyone knows what they show. Use relative links like [Help](CONTRIBUTING.md): they work in every copy of the repo. A profile README comes in World 12.