From 8cb4e733a1033b3a9db8e583c14b8b9d7399cac2 Mon Sep 17 00:00:00 2001 From: David Dorchies <david.dorchies@inrae.fr> Date: Wed, 2 Apr 2025 11:23:11 +0200 Subject: [PATCH] docs(README): complete installation procedure Refs #3 --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 45 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 89b65cb..d9fdbf8 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,51 @@ Le modèle seinebasin3 est réalisée par Artelia et Inrae dans le cadre de l'é commandité par l'EPTB Seine Grands Lacs intitulée "Constitution d’une hydrologie de référence sur le bassin amont de la Seine". -## Installation +## Clonage et installation du package pour le développement + +### Prérequis + +Avoir *GIT* installé sur votre ordinateur. + +### Clonage du dépôt GIT + +Vous devez être un utilisateur connu de +[https://forgemia.inra.fr/](https://forgemia.inra.fr/) et être membre du projet +[seinbasin3](https://forgemia.inra.fr/sgl-hydro-ref/seinebasin3) ou de son +groupe. +Commencez par [créer un jeton d'accès personnel (PAT)](https://mycloudjourney. +medium.com/gitlab-tokens-194c803de73f) avec des permissions de lecture et +d'écriture sur le dépôt (`read_repository` et `write_repository`) dans *Gitlab*. + +- Dans la console *git bash*, tapez : + +```bash +git clone https://<votre-nom-utilisateur>:<votre-pat>@forgemia.inra.fr/sgl-hydro-ref/seinebasin3.git +``` + +> Cela clonera le dépôt dans le dossier courant (par défaut, dans votre dossier +personnel). +> Vous pourrez déplacer ce dossier où vous le souhaitez après sa création. + +### Installation du package et ses dépendances + +- Ouvrez le fichier projet `seinebasin3.Rproj` avec Rstudio. +- Installez les dépendances du package *seinebasin3* avec ce script : + +```r +source("dev/update_packages.R") +``` + +- Installez le package lui-même + +> Cela peut être fait en cliquant sur le bouton "Installer" situé dans +> 'onglet "Build" de Rstudio. +> Mais cela peut aussi être fait en tapant : + +```r +# install.packages("devtools") # Si pas déjà installé +devtools::install() +``` ## Configuration du dossier de données -- GitLab