Commit c8121b0e authored by Anthony FREYERMUTH's avatar Anthony FREYERMUTH
Browse files

[#3] Mise à jour du README. TODO : Mise en page

parent c82ace24
# Livret d'accueil
## Mise à jour
Pour mettre à jour l'application, Git est nécessaire.
### Installation
L'installation de Git se fait par la ligne de commande
#### Windows
Pour pouvoir utiliser ce genre de commandes sous Windows, il existe plusieurs utilitaires pour simuler un environnement Linux, le plus pratique et le plus portable est WSL, disponible en version 2 gratuitement sur le Microsoft Store.
Une fois l'installation terminé il vous suffira de rentrer cette commande :
```
apt install git
```
#### Linux
L'installation la plus facile est celle depuis Linux, en effet il suffit d'utiliser le gestionnaire de paquets natif *apt*.
```
apt install git
```
#### MacOS
Avant d'installer Git, il est préférable d'installer Homebrew sur macOs qui est un gestionnaire de paquet pas installé nativement sur ce système.
```
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```
### Récupération du dépôt
Pour récupérer le dépôt, rentrez la commande suivante dans votre Terminal :
```
git clone https://gitlab.ippon.fr/jarakarama/livretaccueil.git
```
### Configuration
Si vous venez d'installer Git, vous devrez alors configurer vos credentials, pour cela suivez les commandes suivantes :
```
git config user.email <USERNAME>@ippon.fr
git config user.name "Prénom Nom"
```
### Ajouter des fichiers
La première étape est de se placer dans le répertoire du projet depuis le terminal. Pour cela, il faudra utiliser la commande **cd**. Dans mon cas, voici la commande que je dois réaliser si j'ai réaliser la commande **git clone** dès l'ouverture de mon terminal :
```
cd livretaccueil
```
#### Via la CLI
Tout d'abord vérifier que vous êtes bien sur la bonne branche via la commande suivante :
```
git branch
```
Pour réaliser une mise à jour, vous devriez normalement être sur la branche **master**, sinon, placez vous sur cette dernière :
```
git checkout master
```
Une fois placé sur la bonne branche, rajouter / remplacer des fichiers via votre explorateur de fichiers. Une fois terminé, suivez les commandes suivantes :
```
git add -A
git commit -m "Mise à jour des fichiers concernant l'agence de Paris"
git push
```
N'hésitez pas à modifier le message suivant le **-m**, ce n'est qu'un exemple ici.
#### Via une interface graphique
Pour l'interface graphique, un bon utilitaire accessible pour tout type de besoins peut être Visual Studio Code qui est un IDE gratuit multi-plateforme. Les changements que vous aurez réalisés seront disponibles dans l'onglet **Source Control** sur la gauche. Par exemple dans mon interface, seul le fichier *README.md* a été modifié :
<p align="center">
<img src="img/source-control.png" alt="source control" width="200"/>
</p>
Rentrez alors simplement le message de votre modification :
<p align="center">
<img src="img/commit.png" alt="commit" width="200"/>
</p>
Vous pouvez ensuite appuyer sur ✓ pour valider votre modification.
Si le message suivant apparaît : *Would you like to stage all your changes and commit them directly?* c'est que certaines de vos modifications n'ont pas été rajoutés. Pour cela, n'hésitez pas à cliquer sur *Stage All Changes* representé par un logo **➕** si vous voulez tout rajouter ou alors que sur les fichiers qui vous intéressent.
## Utilisation
Pour pouvoir builder l'application :
```
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment