diff --git a/README.md b/README.md index 722e576..c7b0960 100644 --- a/README.md +++ b/README.md @@ -1 +1,40 @@ -# guesstimate \ No newline at end of file +# ⏱️ Guesstimate +Application de rédaction simplifiée d'estimations de temps/coût pour la réalisation de projets. + +Basée sur la méthode d'[estimation à 3 points](https://en.wikipedia.org/wiki/Three-point_estimation). + +[Voir l'instance de démonstration](https://guesstimate.dev.lookingfora.name/) + +## Démarrer à partir des sources + +### Dépendances + +- [Go >= 1.13](https://golang.org/) +- [GNU Make](https://fr.wikipedia.org/wiki/GNU_Make) +- Git +- NodeJS/NPM + +### Étapes + +1. Cloner le projet avec Git + + ``` + git clone https://forge.cadoles.com/wpetit/guesstimate.git + ``` + +2. Se positionner dans le répertoire du projet + + ``` + cd guesstimate + ``` + +3. Générer une version de distribution + + ``` + make deps + make release + ``` + +## Licence + +[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.txt) \ No newline at end of file