- Update user manual to list required software and tools to

build / run sgpemv2


git-svn-id: svn://svn.gna.org/svn/sgpemv2/trunk@417 3ecf2c5c-341e-0410-92b4-d18e462d057c
This commit is contained in:
tchernobog 2006-02-23 22:54:01 +00:00
parent c91a86a9ca
commit c956c12dba
1 changed files with 64 additions and 14 deletions

View File

@ -159,23 +159,73 @@ Graphical display of simulated processes...
@cindex requirements
Some software is needed in order to build and install SGPEM on your
personal computer.
This is the list; if you find it misses something / it lists
personal computer. You will have the need of different pieces of
software installed, whether you are a developer, a user building it
from sources, or just a user that's running the binary a packager
has given to him.
And if you find this section misses something / it lists
the wrong version of a program, please let us know!
@itemize
@item
@emph{GCC with C++ support}, as well as the other standard
GNU tools: make, sed, ld... GCC version >=3.4 is highly
recommended. Please don't report compiling-related
problems with any previous version.
@c % ---- new subsection
@subsection Developers
@item
@emph{libXML2 >= 2.6.15} : we need this to parse saved files.
@dots{}
@c cairo? gtkmm? and so on...
Other than the tools needed by users building from sources,
you'll need:
@end itemize
@table @emph
@item GCC with C++ support
as well as the other standard GNU binutils and tools: make, sed, ld...
GCC version >=3.4 is highly recommended. Please don't report
compiling-related problems with any previous version.
@item Automake >= 1.9
We use a single @file{Makefile.am} to avoid
recursive make. Older versions of automake didn't play right
with it. See @url{http://aegis.sourceforge.net/auug97.pdf} for
the motivations that led to this choice.
@item Autoconf, libtool, autopoint @dots{}
The standard autotool family.
@item Subversion >= 1.2
If you need to update the sources from our repository, or commit
your changes, you'll need Subversion built with SSL support.
@item Dejagnu >= 1.4
The testsuite framework we use as a platform for running tests.
@end table
@c % ---- new subsection
@subsection Building from source
Other than the runtime dependencies, you'll need:
@table @emph
@item SWIG >= 1.3.21
SWIG generates the C++ sources needed to build a module that
Python can use, starting from a simple interface specification.
@end table
@c % ---- new subsection
@subsection Runtime dependencies
To run SGPEMv2, you require:
@table @emph
@item Gtkmm >= 2.8 with Cairo support
The popular C++ jacket for the even-more popular GIMP
ToolKit. We use Cairo to draw our custom widgets.
@item Python >= 2.3
We use Python to let the user write her own policies
in a simple and complete language.
@end table
@c % --------------------------------------------------
@ -206,7 +256,7 @@ For example, on my machine, I would use:
@noindent Being a developer, though, if I had to debug SGPEM, I would type:
@example
@code{CXXFLAGS="-O0 -g -ggdb -pg" ../configure \}
@code{ --prefix=`pwd`/_inst --disable-shared}
@code{ --prefix=`pwd`/_inst}
@end example
@sp 2