glenux-school/l3.libnazgul
glenux-school/l3.libnazgul
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Update README

Browse source
This commit is contained in:
Glenn Y. Rolland 2020-03-03 22:22:15 +01:00
parent f097421098
commit 2586c87885
1 changed files with 15 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README
View file

@ -4,20 +4,28 @@ Un readme qui explique le fonctionnement du projet Libnazgul
COMPILATION COMPILATION
~~~~~~~~~~~ ~~~~~~~~~~~
pour compiler le projet mettez-vous à la racine et faites 'make', Pour compiler le projet mettez-vous à la racine et faites 'make',
ce qui créera notre bibliothèque. ce qui créera notre bibliothèque statique 'libnazgul.a' dans src/
ainsi que les programmes de test dans 'test/'.
UTILISATION UTILISATION
~~~~~~~~~~~ ~~~~~~~~~~~
une fois le projet compilé (voir au-dessus), il vous suffit de mettre Une fois le projet compilé (voir au-dessus), il vous suffit :
"#include "libnazgul.h"" au début de votre programme et ainsi pouvoir # Pendant l'écriture de vos programmes :
utiliser les fonctions de notre bibliothèque. - 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 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 l'énoncé et un répertoire 'rapport' qui contient le rapport. Allez
dans celui-ci (donc /doc/rapport/) et faites 'make'. Ceci créera 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).