diff --git a/README b/README index 5436136..779219c 100644 --- a/README +++ b/README @@ -1,8 +1,23 @@ -Un readme qui explique le fonctionnement du projet +Un readme qui explique le fonctionnement du projet Libnazgul -INTERFACE -~~~~~~~~~ -blabla +COMPILATION +~~~~~~~~~~~ +pour compiler le projet mettez-vous à la racine et faites 'make', +ce qui créera notre bibliothèque. + +UTILISATION +~~~~~~~~~~~ +une fois le projet compilé (voir au-dessus), il vous suffit de mettre +"#include "libnazgul.h"" au début de votre programme et ainsi pouvoir +utiliser les fonctions de notre bibliothèque. + + +DOCUMENTATION +~~~~~~~~~~~~~ +pour voir la documentation allez dans le répertoire '/doc/'. S'y trouve +l'énoncé et un répertoire 'rapport' qui contient le rapport. Allez +dans celui-ci (donc /doc/rapport/) et faites 'make'. Ceci créera +le rapport sous plusieurs formats.