Update license and readme #106
1 changed files with 22 additions and 27 deletions
49
README.md
49
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)
|
||||
|
|
Loading…
Reference in a new issue