Skip to content

This is the multi-page printable view of this section. .

Return to the regular view of this page.

Get Started

Check the prerequisites and complete a first installation.

Move from a clean machine to a working local result.

1 - Requirements

List the tools and access needed before installation.

Keep prerequisites short, exact, and testable.

Tools

  • A supported operating system.
  • Git for retrieving the source.
  • The runtime version required by your project.

Verify

Give readers one command per prerequisite:

$ project --version
project 0.1.0

Replace the placeholder command with your own before publishing.

2 - Installation

Take a new user from source code to a working result.

Show the shortest supported installation path first.

Install

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

Confirm the result

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.