add README

This commit is contained in:
JOLIMAITRE Matthieu 2024-04-29 11:18:53 +02:00
parent 5a40f83a74
commit da121d6e09
2 changed files with 45 additions and 11 deletions

31
README.md Normal file
View file

@ -0,0 +1,31 @@
# Ruche manager
![ruche-manager profile pic](./data/profile.png)
Mange la ruche.
---
## Description
Bot gestionnaire de devoirs, spécialisé pour la majeure SSIE.
## Usage
### Dépendance
- deno
installer via votre package manager :
- windows : `winget install deno`
- archlinux : `sudo pacman -S deno`
- debian : `sudo apt install deno`
- autre : téléchargeable ici : https://deno.land/
### Exécution
1. Token
- Récupérer un token pour Bot discord, d'une application ayant les permissions d'exécuter des interractions et écrire des messages.
- Écrire le token dans un fichier `./token`
2. Lancer
- `./src/bot.ts ./token`