Skip to content

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.