Requirements

Mon, 01 Jan 0001 00:00:00 +0000

Keep prerequisites short, exact, and testable.

Tools

Give readers one command per prerequisite:

$ project --version
project 0.1.0

Replace the placeholder command with your own before publishing.

Mon, 01 Jan 0001 00:00:00 +0000

Show the shortest supported installation path first.

git clone https://github.com/OWNER/PROJECT.git
cd PROJECT
./project start

Tell readers exactly what success looks like: a URL to open, a message to see, or a command whose exit status is zero.

Important

Replace every uppercase placeholder before publishing your project documentation.