70896a91 |
1 | \section{Implementation Specification} |
ea4c19a4 |
2 | |
3 | \subsection{Building \pname} |
4 | |
5 | \subsubsection{Build environment} |
6 | The program has been successfully built under Linux with the following |
7 | programs: |
8 | \begin{itemize} |
9 | \item GCC version 4.1.2 |
10 | \item GNU make version 3.81 |
11 | \item Doxygen version 1.4.2 |
12 | \item Debian teTex package, version 3.0 |
13 | \item Graphviz dot version 2.8 |
14 | \end{itemize} |
15 | At least the the software (without docs) should be compile on any |
16 | POSIX compatible system with a fairly recent GCC and GNU make |
17 | installed. |
18 | |
19 | \subsubsection{Build instructions} |
20 | There is a simple \verb|Makefile| which eases the standard build |
21 | process for the application and documentation. Changes may be |
22 | necessary to compile on a system other than stated in the last |
23 | paragraph. |
24 | \\ |
25 | |
26 | To build the application, follow these easy steps: |
27 | \begin{itemize} |
28 | |
29 | \item Change directory to the \pname direcory.\\ |
30 | (Hint: That is the directory containing the subdirs \verb|src| |
31 | and \verb|doc|.) |
32 | |
33 | \item Run \emph{make} (or \emph{gmake}). |
34 | |
35 | \item If you like, put the resulting binary somewhere in your system. |
36 | \end{itemize} |
37 | |
38 | |
39 | Further useful targets in the \verb|Makefile|: |
40 | \begin{itemize} |
41 | |
42 | \item \verb|doc|: Build the Latex documentation (this document) in the |
43 | \verb|doc| subfolder. |
44 | |
45 | \item \verb|doxy|: Build Doxygen source code documentation.\\ |
46 | The Doxygen output is placed in the subdir \verb|doxy|. |
47 | |
48 | \item \verb|clean|: Delete all files generated by the make process, |
49 | including binaries and documentation. |
50 | |
51 | \end{itemize} |