add readme

This commit is contained in:
JOLIMAITRE Matthieu 2024-04-12 17:40:19 +02:00
parent f159fab9a9
commit 7a0ef26684

19
README.md Normal file
View file

@ -0,0 +1,19 @@
# OKImeter
Compte vos OKIs.
## Usage
1. Aller chercher un token sur le gitlab concerné.
- disponible sur https://gitlab.cri.epita.fr/-/user_settings/personal_access_tokens
- pendant la création, cocher au moins `read_api`
2. Télécharger ce programme.
- lien de téléchargement : https://git.barnulf.net/mb/okimeter/releases/download/latest/okimeter
- `chmod a+x okimeter`
3. Exécuter ce programme avec le token récupéré.
- `./okimeter [TOKEN]`