From 2fa0c145f2e8f039c026faf9edac85f355128efc Mon Sep 17 00:00:00 2001 From: Alessandre Laguierce Date: Sun, 6 Apr 2025 22:14:18 +0200 Subject: [PATCH] docs: better README.md --- README.md | 38 +++++++++++++++++++++++++++++++++++++- 1 file changed, 37 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e601e59..23673de 100644 --- a/README.md +++ b/README.md @@ -1 +1,37 @@ -salut +## IT202 - G1-E1-26136 + +Bienvenue sur le README de la meilleure équipe du projet édition 2025. Notre objectif est simple : viser la première place du leaderboard ! Pourquoi ? Parce qu'au pire, on finit dans les étoiles ! + +### Compilation + +Pour compiler le projet dans le répertoire `./build`, exécuter la commande ci-après : + +```sh +make +``` + +### Installation + +Pour installer les binaires de tests, ainsi que les deux bibliothèques (statique et dynamique) dans le répertoire `./install`, exécuter la commande : + +```sh +make install +``` + +À noter que cette commande génère les fichiers compilés si nécessaire. + +### Comparaison pthreads + +La comparaison avec la bibliothèque de la glibc (pthreads) peut être faite à l'aide de graphes présents dans le répertoire `./graphs/out`. Pour les générer, exécuter la commande : + +```sh +make graphs +``` + +### Nettoyage + +Pour retrouver un dépôt vierge, exécuter la commande : + +```sh +make clean +```