From e88fe8ecf7362443817c8e616b2f9e11469bca65 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Nicolas=20FERNANDEZ=20NU=C3=91EZ?=
<nicolas.fernandez@ird.fr>
Date: Tue, 7 Jan 2025 14:29:14 +0100
Subject: [PATCH] Doc: rework on installations pages
---
documentations/en/pages/installations.md | 65 ++++++++++++----------
documentations/fr/pages/installations.md | 70 +++++++++++++-----------
2 files changed, 72 insertions(+), 63 deletions(-)
diff --git a/documentations/en/pages/installations.md b/documentations/en/pages/installations.md
index 9cf1c8a..4a84195 100644
--- a/documentations/en/pages/installations.md
+++ b/documentations/en/pages/installations.md
@@ -1,22 +1,24 @@
-# **Installations**
+# **In stallations**
## **Conda**
+
!!! warning
- Dependency required
+ **Dependency required**
GeVarLi use the use the free and open-source package manager **Conda**.
**If you don't have Conda**, we hihly recommad to installed it with **Miniforge**.
-!!! note
- Read why: [Avoiding the Pitfalls of the Anaconda License: A Practical Guide](https://mivegec.pages.ird.fr/dainat/malbec-fix-conda-licensing-issues/en/)
-!!! tip
- If you need help, you can use the script: [Install_Conda-with-Miniforge3.sh](https://forge.ird.fr/transvihmi/nfernandez/install_conda-with-miniforge3)
+You can **download** and **install** the latest version of **Miniforge** for your specific OS from the git repository: [Conda-forge / Miniforge](https://github.com/conda-forge/miniforge/releases).
+
+!!! warning
+ We higly recommand to **reset default channels** of yours conda distribution and to **update** it regulary!
-Otherwise, you can **download** and **install** the [latest version of Miniforge](https://github.com/conda-forge/miniforge/releases) for your specific OS.
+!!! note
+ Read why: [Avoiding the Pitfalls of the Anaconda License](https://mivegec.pages.ird.fr/danat/malbec-fix-conda-licensing-issues/en/).
!!! shell
- Example bash script for Linux\_x86\_64-bit** or Windows Subsystem for Linux (WSL) systems
+ _Example script for Linux\_x86\_64-bit** or Windows Subsystem for Linux (WSL) systems_
```shell
# Download
curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
@@ -44,38 +46,41 @@ Otherwise, you can **download** and **install** the [latest version of Miniforge
~/miniforge3/condabin/conda init
```
-!!! warning
- We higly recommand to **set channels** and **update**!
-!!! note
- Read why: [Avoiding the Pitfalls of the Anaconda License](https://mivegec.pages.ird.fr/danat/malbec-fix-conda-licensing-issues/en/)
-
-## **GeVarLi**
-!!! warning
- Given that Conda is installed
+!!! tip
+ If you need help, you can use this side script: [Install_Conda-with-Miniforge3.sh](https://forge.ird.fr/transvihmi/nfernandez/install_conda-with-miniforge3)
-You can **download** GeVarLi from [IRD-Forge git repository](https://forge.ird.fr/transvihmi/nfernandez/GeVarLi), as zip file:
-<img src="../../../images/download_button.png" width="300" height="60">
+## **GeVarLi**
-_Exemple script to download GeVarLi to your home/ directory_
-```shell
-# Download
-curl https://forge.ird.fr/transvihmi/nfernandez/GeVarLi/-/archive/main/GeVarLi-main.tar.gz -o ~/GeVarLi-main.tar.gz
+!!! warning
+ **Given that Conda is installed**
-# Untar
-tar -xzvf ~/GeVarLi-main.tar.gz
+You can **download** GeVarLi as zip file from the git repository: [IRD-Forge / GeVarLi](https://forge.ird.fr/transvihmi/nfernandez/GeVarLi).
-# Clear
-rm -f ~/GeVarLi-main.tar.gz
+<div style="text-align: center;">
+ <img src="../../../images/download_button.png" width="100" height="200">
+</div>
-# Rename
-mv ~/GeVarLi-main/ ~/GeVarLi/
+!!! shell
+ _Exemple script to download GeVarLi to your ```/home/``` directory_
+ ```shell
+ # Download
+ curl https://forge.ird.fr/transvihmi/nfernandez/GeVarLi/-/archive/main/GeVarLi-main.tar.gz -o ~/GeVarLi-main.tar.gz
+
+ # Untar
+ tar -xzvf ~/GeVarLi-main.tar.gz
+
+ # Clear
+ rm -f ~/GeVarLi-main.tar.gz
+
+ # Rename
+ mv ~/GeVarLi-main/ ~/GeVarLi/
```
!!! tip
- Otherwise, you can also **clone** and **update** GeVarLi:
+ Otherwise, you can also **clone** and **update** GeVarLi.
- _Exemple script to clone and update it, to your home/ directory_
+ _Exemple script to clone and update it, to your ```/home/``` directory_
```shell
# Clone
git clone --depth 1 https://forge.ird.fr/transvihmi/nfernandez/GeVarLi.git ~/GeVarLi/
diff --git a/documentations/fr/pages/installations.md b/documentations/fr/pages/installations.md
index 303b2da..bf2a05c 100644
--- a/documentations/fr/pages/installations.md
+++ b/documentations/fr/pages/installations.md
@@ -1,22 +1,24 @@
# **Installations**
## **Conda**
+
!!! warning
- Dépendance requise
+ **Dépendance requise**
-GeVarLi utilise le gestionnaire de paquets gratuit et open-source **Conda**.
+GeVarLi utilise le gestionnaire de paquets gratuit et open-source **Conda**.
**Si vous n'avez pas Conda**, nous vous recommandons vivement de l'installer avec **Miniforge**.
-!!! note
- Lire pourquoi: [Éviter les Pièges de la Licence Anaconda : Guide Pratique](https://mivegec.pages.ird.fr/dainat/malbec-fix-conda-licensing-issues/fr/)
-!!! tip
- Si vous avez besoin d'aide, vous pouvez utiliser le script annexe : [Install_Conda-with-Miniforge3.sh](https://forge.ird.fr/transvihmi/nfernandez/install_conda-with-miniforge3)
+Vous pouvez **télécharger** et **installer** la dernière version de **Miniforge** spécifique à votre système d'exploitation depuis le dépôt git : [Conda-forge / Miniforge](https://github.com/conda-forge/miniforge).
-Sinon, vous pouvez **télécharger** et **installer** la [dernière version de Miniforge](https://github.com/conda-forge/miniforge/releases) spécifique à votre système d'exploitation.
+!!! warning
+ Nous vous recommandons fortement de **redéfinir les canaux par défaut** de votre distribution conda et de la **mettre à jour** régulièrement !
+
+!!! note
+ Lire pourquoi: [Éviter les Pièges de la Licence Anaconda : Guide Pratique](https://mivegec.pages.ird.fr/dainat/malbec-fix-conda-licensing-issues/fr/).
!!! shell
- Exemple de script bash pour les systèmes Linux\_x86\_64 bits ou Sous-système Windows pour Linux (WSL)
+ _Exemple de script pour les systèmes Linux\_x86\_64 bits ou Sous-système Windows pour Linux (WSL)_
```shell
# Download
curl -L -O https://github.com/conda-forge/miniforge/releases/latest/download/Miniforge3-Linux-x86_64.sh
@@ -43,45 +45,47 @@ Sinon, vous pouvez **télécharger** et **installer** la [dernière version de M
# Init
~/miniforge3/condabin/conda init
```
-
-!!! warning
- Nous vous recommandons fortement de **définir des canaux** et de **mettre à jour** !
-!!! note
- Lire pourquoi: [Éviter les Pièges de la Licence Anaconda : Guide Pratique](https://mivegec.pages.ird.fr/dainat/malbec-fix-conda-licensing-issues/fr/)
+
+!!! tip
+ Si vous avez besoin d'aide, vous pouvez utiliser ce script annexe : [Install_Conda-with-Miniforge3.sh](https://forge.ird.fr/transvihmi/nfernandez/install_conda-with-miniforge3)
## **GeVarLi**
-!!! warning
- Présumant que Conda est installé
-
-Vous pouvez **télécharger** GeVarLi depuis le [dépôt git sur IRD-Forge](https://forge.ird.fr/transvihmi/nfernandez/GeVarLi), en tant que fichier zip :
-<img src="../../../images/download_button.png" width="300" height="60">
-
-_Exemple de script pour télécharger GeVarLi dans votre répertoire home/_
-```shell
-# Download
-curl https://forge.ird.fr/transvihmi/nfernandez/GeVarLi/-/archive/main/GeVarLi-main.tar.gz -o ~/GeVarLi-main.tar.gz
+!!! warning
+ **Présumant que Conda est installé**
-# Untar
-tar -xzvf ~/GeVarLi-main.tar.gz
+Vous pouvez **télécharger** GeVarLi en tant que fichier zip depuis le dépôt git : [IRD-Forge / GeVarLi](https://forge.ird.fr/transvihmi/nfernandez/GeVarLi).
-# Clean
-rm -f ~/GeVarLi-main.tar.gz
+<div style="text-align: center;">
+ <img src="../../../images/download_button.png" width="100" height="200">
+</div>
-# Rename
-mv ~/GeVarLi-main/ ~/GeVarLi/
-```
+!!! shell
+ _Exemple de script pour télécharger GeVarLi dans votre répertoire ```/home/```_
+ ```shell
+ # Download
+ curl https://forge.ird.fr/transvihmi/nfernandez/GeVarLi/-/archive/main/GeVarLi-main.tar.gz -o ~/GeVarLi-main.tar.gz
+
+ # Untar
+ tar -xzvf ~/GeVarLi-main.tar.gz
+
+ # Clean
+ rm -f ~/GeVarLi-main.tar.gz
+
+ # Rename
+ mv ~/GeVarLi-main/ ~/GeVarLi/
+ ```
!!! tip
- Sinon, vous pouvez aussi **cloner** et **mettre à jour** à jour GeVarLi :
+ Sinon, vous pouvez aussi **cloner** et **mettre à jour** à jour GeVarLi.
- _Exemple de script pour le cloner et le mettre à jour, dans votre répertoire home/_
+ _Exemple de script pour le cloner et le mettre à jour, dans votre répertoire ```/home/```_
```shell
# Clone
git clone --depth 1 https://forge.ird.fr/transvihmi/nfernandez/GeVarLi.git ~/GeVarLi/
cd ~/GeVarLi/
-
+
# Update/Pull (présumant que vous êtes dans le répertoire GeVarLi/)
git reset --hard HEAD && git pull --depth 1 --verbose
```
--
GitLab