From d4081a3831c9b7cbce1b398df3dae211e8d79c9a Mon Sep 17 00:00:00 2001 From: Mylloon Date: Sun, 3 Sep 2023 19:09:48 +0200 Subject: [PATCH] refactor readme --- README.md | 49 ++++++++++++++++++++++--------------------------- 1 file changed, 22 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 5fa6ab6..5d00dd3 100644 --- a/README.md +++ b/README.md @@ -4,31 +4,9 @@ ## Lancer le bot -### En local +### Avec docker-compose (recommandé) -> Cloner le repo - -> Spécifier un fichier `.env` en suivant [l'exemple](config/example.env) - -> Installer les dépendances du bot - -```bash -npm install -``` - -Assurez-vous d'avoir [FFmpeg](https://ffmpeg.org/download.html) d'installé. - -> Lancer le bot - -```bash -npm run main -``` - -### Avec Docker (recommandé) - -> Facile avec `docker-compose` - -```docker +```yaml version: "3.9" services: @@ -42,6 +20,23 @@ services: restart: unless-stopped ``` +### En local + +- Assurez-vous d'avoir [FFmpeg](https://ffmpeg.org/download.html) d'installé sur le système. +- Cloner le dépôt +- Spécifier un fichier `.env` en suivant [l'exemple](config/example.env) +- Installer les dépendances du bot + + ```bash + npm install + ``` + +- Lancer le bot + + ```bash + npm run main + ``` + ## Variables d'environnements | Nom | Description | Par défaut | Commentaire | @@ -55,16 +50,16 @@ services: | :-------: | :-------------------------------------------------------------------------: | | `/config` | Dossier de configuration, par exemple, c'est ici que la base de donnée est. | -# Contribuer +## Contribuer Toute contribution est la bienvenue ! Pour commencer, lis le [fichier de contribution](./CONTRIBUTING.md). -# Licence +## Licence Voir le [fichier LICENCE](./LICENSE). -# Crédits +## Crédits [Photo de profil](https://picrew.me/image_maker/1497656)