Update README

This commit is contained in:
Glenn Y. Rolland 2020-03-03 22:24:31 +01:00
parent 2586c87885
commit 9f6ca06046

36
README
View file

@ -1,5 +1,23 @@
Un readme qui explique le fonctionnement du projet Libnazgul
#-------------------------------------------------------------------%
#
# LIBNAZGUL : Library
#
#-------------------------------------------------------------------%
#
# IUP GMI 2, Module de Système. 2003-2004.
# Cours de J-M. Rifflet.
#
#-------------------------------------------------------------------%
#
# Projet de :
# Glenn ROLLAND,
# Sebastian SCHAWOHL,
# Rivka ZANA
#
# pour plus de détails au sujet du projet, voir le
# fichier README
#
#-------------------------------------------------------------------%
COMPILATION
@ -9,23 +27,29 @@ ce qui cr
ainsi que les programmes de test dans 'test/'.
UTILISATION
~~~~~~~~~~~
Une fois le projet compilé (voir au-dessus), il vous suffit :
# Pendant l'écriture de vos programmes :
* Pendant l'écriture de vos programmes :
- de mettre "#include "libnazgul.h"" au début de votre programme .c,
# A la compilation
* 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 & RAPPORT
~~~~~~~~~~~~~~~~~~~~~~~
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 (dvi, postscript, pdf).