ajout doc git

doc/docs/index.md

@@ -1,3 +1,4 @@
 # Welcome to Gregandoc
 
-La documentation est en développement pour le moment...
+La documentation est en développement pour le moment, mais on peux y trouver des infos sur l'outil GIT:
+- [Git](linux/git.md)

doc/docs/linux/git.md

@@ -0,0 +1,203 @@
+
+# GIT Source Code Management
+
+Git est un système de gestion de versions partagé qui fut développé en 2005 par le créateur de Linux Linus Thorvalds et publié sous licence libre GNU-GPLv2.
+Il permet de stocker son code source en ligne pour y accéder de n'importe où et le partager facilement.
+
+<img src="../../assets/git-branch.png">
+
+## Installation
+
+```bash
+sudo apt install git -y
+```
+
+## Les principales commandes
+
+- Cloner un dépôt distant sur sa machine locale:
+
+```bash
+git clone https://gitlab.com/mon-dépôt-distant.git
+```
+
+- Initialiser un dossier de projet pour le "pousser" en ligne:
+
+```bash
+cd mon-projet/
+git init
+```
+
+- Ajouter des fichiers au suivi (pour les synchroniser vers un dépôt distant):
+
+```bash
+git add fichier1 fichier2
+```
+
+- Créer un enregistrement (une version) du code avec un commentaire:
+
+```bash
+git commit -m "commentaire (exemple: modification du fichier1, ajout fonction test)"
+```
+
+- Pousser les changements vers le dépôt distant (Gitlab ou Github par exemple):
+
+```bash
+git push
+```
+
+- Changer de branche dans le projet:
+
+```bash
+git checkout nom-de-la-branche
+```
+
+- Créer une nouvelle branche à partir de la branche actuelle:
+
+```bash
+git branch nom-nouvelle-branche
+```
+
+- Pousser une branche nouvellement créée en local vers le dépôt distant:
+
+```bash
+git push origin nom-nouvelle-branche
+```
+
+- Effacer une branch locale:
+
+```bash
+git branch -d branche-a-effacer
+```
+
+- Effacer une branche du dépôt distant:
+
+```bash
+git push origin --delete branche-a-effacer
+```
+
+## Workflow
+
+### Cloner un dépôt distant en local, l'éditer puis pousser les changement
+
+- Cloner un dépôt distant sur sa machine locale:
+
+```bash
+git clone https://gitlab.com/mon-dépôt-distant.git
+```
+
+- Entrer dans le dossier du dépôt et modifier un fichier:
+
+```bash
+cd mon-dépôt-distant/
+# modification sur un fichier
+```
+
+- Ajouter le fichier modifié au suivi:
+
+```bash
+git add fichier-modifié
+```
+
+- Créer un enregistrement de la modification
+
+```bash
+git commit -m "modif fichier-modifié"
+```
+
+- Pousser les changements sur le dépôt en ligne:
+
+```bash
+git push
+```
+
+### Initialiser un dépôt git dans un fichier local afin de le pousser sur un dépôt en ligne
+
+- On entre dans le dossier et on l'initialise en tant que dépôt git:
+
+```bash
+cd mon-dépôt-local/
+git init
+```
+
+- Ajouter tout les fichiers du dossier au suivi:
+
+```bash
+git add *
+# ou
+git add .
+```
+
+- Ajouter l'adresse du dépôt distant qui va recevoir le dépôt local:
+
+```bash
+git remote add origin https://gitlab.com/mon-user/mon-nouveau-dépôt.git
+```
+
+- Créer un enregistrement avec un commentaire:
+
+```bash
+git commit -m "premier push"
+```
+
+- Pousser le nouveau dépôt vers le dépôt distant en ligne:
+
+```bash
+git push origin main # ou le nom de la branche
+```
+
+## Autres commandes utiles
+
+- Récupérer localement les changements du dépôt distant:
+
+```bash
+git pull
+```
+
+:warning: Si des changements ont été effectués localement depuis le git clone ou depuis le dernier git pull, git vous avertira qu'il faut remiser les changements (annuler) ou les valider (pousser les changements vers le dépôt distant) pour ne pas écraser ceux-ci avec la version du code se trouvant sur le dépôt distant.
+
+- Savoir sur quelle branche on se trouve et les branches disponibles localement:
+
+```bash
+git branch 
+```
+
+- Créer une nouvelle branche et basculer vers la nouvelle branche:
+
+```bash
+git checkout -b nom-nouvelle-branche
+```
+
+- Connaitre l'état du dépôt local:
+
+```bash
+git status
+```
+
+- Revenir à l'état après le git clone en éffaçant les chagements éffectués:
+
+```bash
+git reset --hard HEAD
+```
+
+- Visualiser les différences entre les fichiers originaux et les fichiers modifiés:
+
+```bash
+git diff 
+```
+
+## Utils
+
+Pour éviter de faire des "git branch" pour savoir dans quelle branche on se trouve, on peut ajouter la référence dans le chemin de notre terminal (Linux) en modifiant les fichier ~/.bashrc:
+
+```bash
+sudo nano ~/.bashrc
+# y ajouter ces lignes:
+git_branch() {
+  git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/(\1)/'
+}
+export PS1="\[\e]0;\u@\h: \w\a\]${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]:\[\033[38;5;5m\]\$(git_branch)\[\033[00m\]\$ "
+```
+
+## Référence
+
+[Documentation GIT](https://git-scm.com/)

doc/mkdocs.yml

@@ -27,3 +27,4 @@ nav:
     - Accueil: index.md
     - Linux:
         - linux/index.md
+        - linux/git.md