Aller au contenu

Version imprimable multipages. .

Retour à la version par défaut.

Premiers pas

Vérifier les prérequis et réaliser une première installation.

Passez d’une machine propre à un résultat local fonctionnel.

1 - Prérequis

Lister les outils et les accès nécessaires avant l’installation.

Gardez les prérequis courts, précis et vérifiables.

Outils

  • Un système d’exploitation pris en charge.
  • Git pour récupérer les sources.
  • La version d’exécution requise par votre projet.

Vérifier

Donnez une commande par prérequis :

$ project --version
project 0.1.0

Remplacez cette commande fictive par la vôtre avant publication.

2 - Installation

Mener un nouvel utilisateur des sources à un résultat fonctionnel.

Présentez d’abord le chemin d’installation pris en charge le plus court.

Installer

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

Confirmer le résultat

Indiquez précisément à quoi ressemble la réussite : une URL à ouvrir, un message à voir ou une commande qui renvoie zéro.

Important

Remplacez tous les éléments en majuscules avant de publier votre documentation.