diff --git a/doc/rapport/arbo.tex b/doc/rapport/arbo.tex index 9af022c..6b0c8ff 100644 --- a/doc/rapport/arbo.tex +++ b/doc/rapport/arbo.tex @@ -8,19 +8,18 @@ Libnazgul/ |-- Makefile // Règles de compilation |-- doc/ | |-- ennonce // Enoncé du projet en format postscript -| |-- rapport/ // Rapport Latex +| `-- rapport/ // Rapport Latex | |-- Makefile // Règles de compilation -| |-- ... +| `-- ... | |--test | |-- Makefile // Règles de compilation -| |-- create_delete // Le main de la fonction -| |-- put_get_mono // Test avec un seul processus -| |-- put_get_multi // Test avec plusieurs processus +| |-- create_delete // Le main de la fonction +| `-- *.c // Programmes de test | -| -|-- src/ // Sources de la bibliothèque +`-- src/ // Sources de la bibliothèque |-- Makefile // Règles de compilation - |-- ... + |-- *.h // En-têtes pour l'utilisation de Libnazgul + `-- *.c // Sources de Libnazgul \end{verbatim} diff --git a/doc/rapport/manuel.tex b/doc/rapport/manuel.tex index 97c5d60..08c8905 100644 --- a/doc/rapport/manuel.tex +++ b/doc/rapport/manuel.tex @@ -1,17 +1,30 @@ \chapter{Manuel d'utilisation} -\section{Que faire de nos sources? \ldots les compiler} +\section{Que faire de nos sources?} %\subsection{Les compiler} \par Pour pouvoir utiliser notre bibliotèque, il faut commencer par la -créer. Pour cela placez-vous dans le répertoire de l'archive (noté ici - \verb+/+) ou dans le sous-répertoire \verb+src/+ et tapez ``\verb+make+''. +compiler. Pour cela placez-vous dans le répertoire racine de l'archive (noté ici + \verb+/+) ou dans son sous-répertoire \verb+src/+ + +et tapez ``\verb+make+''. Cela compilera la bibliothèque +(fichier \verb+libnazgul.a+) ainsi que les divers programmes de test dans +l'archive. -\section{Que faire ensuite? \ldots inclure notre bibliothèque} -%\subsection{Inclure notre bibliothèque dans un programme} +\section{Comment utiliser Libnazgul ?} -\par Dans votre programme, si vous voulez utiliser notre bibliothèque -il vous suffit de l'inclure. Au début de votre programme tapez ``\verb+#include ''libnazgul.h``+''. -\par Une fois notre bibliothèque incluse, vous pourrez sans problèmes -appeler les fonctions contenues à l'intérieur : {\it msgSpaceCreate(\ldots), msgPut(\ldots), msgFree(\ldots) etc\dots} +\par Une fois le projet compilé (voir ci-dessus), vous il vous est possible +d'utiliser {\sc Libnazgul}. +Il vous faudra pendant l'écriture de vos programmes C/C++, +mettre \verb+#include libnazgul.h+ au début des fichiers utilisant la bibliothèque. +\par De même il faudra prendre bien soin, à la compilation de vos programme de : +\begin{itemize} +\item{spécifier (option \verb+-I+) le répertoire où se trouvent les +en-têtes (fichiers *.h) de la bibliothèque {\sc Libnazgul},} +\item{indiquer (option \verb+-L+) le chemin vers le fichier \verb+libnazgul.a+,} +\item{renseigner le compilateur (option \verb+-l+) sur les bibliotheques nécessaires pour utiliser les fonctions de {\sc Libnazgul} : nazgul, rt, et pthreads.} +\end{itemize} +\par Vous pourrez ainsi sans problèmes appeler toutes les fonctions fournis +par {\sc Libnazgul} : {\it msgSpaceCreate(\ldots), msgPut(\ldots), msgFree(\ldots), +etc\dots}