X-Git-Url: http://gitweb.hachti.de/?a=blobdiff_plain;f=pc-tools%2Fldc2%2Fdoc%2Fimpl_spec.tex;h=474f722be9b4783c572f46996dcecb108100ce31;hb=ea4c19a49ff6621c58e0c4bba5ab5d271a3604c8;hp=ae7a6d7b28ccdf7a39afca059477a5fec09f62bd;hpb=c7358c239dea2dd30ab2a3f586efa2e4382c3c6c;p=h316.git diff --git a/pc-tools/ldc2/doc/impl_spec.tex b/pc-tools/ldc2/doc/impl_spec.tex index ae7a6d7..474f722 100644 --- a/pc-tools/ldc2/doc/impl_spec.tex +++ b/pc-tools/ldc2/doc/impl_spec.tex @@ -1,2 +1,51 @@ \section{Implementation Specification} ---- To be done --- + +\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}