*** empty log message ***

[h316.git] / pc-tools / ldc2 / doc / impl_spec.tex

\section{Implementation Specification}

\subsection{Building \pname}

\subsubsection{Build environment}
The program has been successfully built under Linux with the following
programs:
\begin{itemize}
\item GCC version 4.1.2
\item GNU make version 3.81
\item Doxygen version 1.4.2
\item Debian teTex package, version 3.0
\item Graphviz dot version 2.8
\end{itemize}
At least the the software (without docs) should be compile on any 
POSIX compatible system with a fairly recent GCC and GNU make 
installed.

\subsubsection{Build instructions}
There is a simple \verb|Makefile| which eases the standard build
process for the application and documentation. Changes may be
necessary to compile on a system other than stated in the last 
paragraph.
\\

To build the application, follow these easy steps:
\begin{itemize}

\item Change directory to the \pname direcory.\\
(Hint: That is the directory containing the subdirs \verb|src| 
and \verb|doc|.)

\item Run \emph{make} (or \emph{gmake}).

\item If you like, put the resulting  binary somewhere in your system.
\end{itemize}


Further useful targets in the \verb|Makefile|:
\begin{itemize}

\item \verb|doc|: Build the Latex documentation (this document) in the
\verb|doc| subfolder.

\item \verb|doxy|: Build Doxygen source code documentation.\\
The Doxygen output is placed in the subdir \verb|doxy|.

\item \verb|clean|: Delete all files generated by the make process,
including binaries and documentation.

\end{itemize}