diff --git a/README.md b/README.md index 7fc930a..5a648ee 100644 --- a/README.md +++ b/README.md @@ -1,117 +1,19 @@ # Repo Officiel du Discord Plex FR -Retrouvez-nous ici : https://discord.gg/ERpYMqS - ## Table des matières -* [Comment utiliser Git](#wiki) -* [Docker-compose](#Docker-compose) -* [Wiki](#Wiki) +* [Qui sommes-nous ?](#) +* [A quoi sert ce dépot ?](#) +* [Comment nous rejoindre ?](#) -## Comment utiliser Git +## Qui sommes-nous ? -Clonez le dépot sur votre machine `git clone https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo.git` +Nous sommes une communauté francophone autour du logiciel Plex. +... -### Pour chaque modification, attention à bien suivre cette procédure si vous voulez éviter des conflits de versions +## A quoi sert ce dépot ? -- Créez votre branche via la GUI Gitea (idéalement votre pseudo) ex : `Benj` +Ce dépot nous sert a stocker les composes / aides / tutos / ... qui nous permettent d'aider la communauté. L'avantage du dépot est que toutes personnes inscrits peu contribuer. -![mabanche](https://i.imgur.com/0KLNFSG.png) +## Comment nous rejoindre ? -- Rapatriez les dernières modifications : `git pull` -- Mettez vous sur votre branche : `git checkout mabranche` -- Faites vos modificatiosn (création de fichiers etc) -- Récupérez les éventuelles denrières modifications : `git pull` puis `git merge master` -- Ajoutez les nouveaux fichiers : `git add .` ou `git add -A` -- Validez les modif : `git commit -m "ma super modif"` -- Balancez sur le serveur : `git push` -- Et ouvrez une pull request via la GUI - - -Quand la pull request est close et/ou mergé, pensez à supprimer votre branche, -vous pourrez la recréer plus tard quand vous aurez besoin... - -### Petit reminder - -- **ON NE TRAVAILLE JAMAIS SUR LE MASTER** - -- **Un renommage de répertoire cause un conflit généralement, nécessite intervention manuelle** - -- `git status` > donne la branche courante ainsi que l'état des fichiers modifiés -> git status -> Sur la branche master -> Votre branche est à jour avec 'origin/master'. -> -> Modifications qui ne seront pas validées : -> (utilisez "git add ..." pour mettre à jour ce qui sera validé) -> (utilisez "git checkout -- ..." pour annuler les modifications dans la copie de travail) -> -> modifié : README.md -> -> aucune modification n'a été ajoutée à la validation (utilisez "git add" ou "git commit -a") - - -- `git add toto.pouet` ou `git add .` > ajout les modifications sur toto.pouet ou sur tous les fichiers au prochain commit - - -- `git commit -m "mon super message"` > on pose le commit avec un message qui explique ce que l'on a fait (pratique pour retrouver ca plus tard si besoin) - - -- `git pull` > on récupère toutes les dernières modifs du serveur - - -- `git merge master` > (doit être fait après un `git pull`) on récupère toutes les dernières modifs du master pour les mettre sur la branche courante - -### Au secours - -#### J'ai fait mes modif sur le master (sans commit) - -- `git stash` > je sauvegarde mes modifs en local et rétablis le dernier commit -- `git pull` > je récupère des dernières modifs du serveur -- `git checkout mabranche` > je changement de branche -- `git merge master` > je récupère les dernières modifs du master sur ma branche -- `git stash apply` > j'applique ma sauvegarde local -- je poursuis mes modifs et je add/commit/push quand j'ai fini - -## Docker-compose - -### Fonctionnement - -Le répertoire `docker-compose/` contient uniquement les docker-compose de chaque service/application. - -L'arborescence doit être la suivante : -`docker-compose//docker-compose.yml` -- `` : le nom de l'application ou service à rajouter - -### Possibilité - -Le bot pourrait appeler le contenu de chaque application selon cette commande -`.docker-compose ` -Il chercherait selon l'url suivant : -`https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/master/docker-compose//docker-compose.yml` -Si HTTP 200 alors on affiche le contenu retourné -Sinon HTTP 404 alors on affiche `la page n'existe pas` - - -Exemple ok: -> `.docker-compose plex` -> renvoie le contenu de -> https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/master/docker-compose/plex/docker-compose.yml - -Exemple ko: -> `.docker-compose pouet` -> renvoie `La page que vous demandez n'existe pas` - - - -## Wiki - -fichiers au format md (markdown) - -### Possibilité - -Le bot pourrait appeler le contenu de chaque application selon cette commande -`.wiki ` -Il chercherait selon l'url suivant : -`https://gitea.zoz-serv.org/Zoz/plex_fr_discord_repo/raw/branch/master/wiki/.md` -Si HTTP 200 alors on affiche le contenu retourné -Sinon HTTP 404 alors on affiche `la page n'existe pas` +Nous sommes sur Discord, a cette adresse : https://discord.gg/ERpYMqS \ No newline at end of file