From 2586c878853a2c8e7e75d6867be796c5d63c0f99 Mon Sep 17 00:00:00 2001 From: "Glenn Y. Rolland" Date: Tue, 3 Mar 2020 22:22:15 +0100 Subject: [PATCH] Update README --- README | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/README b/README index 779219c..6ac69f6 100644 --- a/README +++ b/README @@ -4,20 +4,28 @@ Un readme qui explique le fonctionnement du projet Libnazgul COMPILATION ~~~~~~~~~~~ -pour compiler le projet mettez-vous à la racine et faites 'make', -ce qui créera notre bibliothèque. +Pour compiler le projet mettez-vous à la racine et faites 'make', +ce qui créera notre bibliothèque statique 'libnazgul.a' dans src/ +ainsi que les programmes de test dans 'test/'. 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. +Une fois le projet compilé (voir au-dessus), il vous suffit : +# Pendant l'écriture de vos programmes : + - de mettre "#include "libnazgul.h"" au début de votre programme .c, +# A la compilation + - spécifier (option -I) le répertoire où se trouvent les en-têtes (.h) + de la bibliothèque libnazgul + - indiquer (option -L) le chemin vers le fichier 'libnazgul.a' + - renseigner le compilateur (-l) sur les bibliotheques utilisées : + libnazgul, librt, et libpthreads. +Vous pourrez ainsi utiliser toutes les fonctions de notre bibliothèque. DOCUMENTATION ~~~~~~~~~~~~~ -pour voir la documentation allez dans le répertoire '/doc/'. S'y trouve +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. +le rapport sous plusieurs formats (dvi, postscript, pdf).