1.1 --- a/doc/getstart.dox	Wed Aug 17 15:26:00 2005 +0000
     1.2 +++ b/doc/getstart.dox	Wed Aug 17 20:37:36 2005 +0000
     1.3 @@ -9,6 +9,7 @@
     1.4  difficulties don't hesitate to
     1.5  <a href="http://lemon.cs.elte.hu/mailinglists.html">ask</a>.
     1.6  
     1.7 +
     1.8  \section requirementsLEMON Hardware and software requirements
     1.9  
    1.10  In LEMON we use C++ templates heavily, thus compilation takes a
    1.11 @@ -16,18 +17,32 @@
    1.12  advantageous. But otherwise there are no special hardware requirements.
    1.13  
    1.14  You will need a recent C++ compiler. Our primary target is the GNU C++
    1.15 -Compiler (g++), from version 3.3 upwards. We also checked the Intel C
    1.16 -compiler (icc). Microsoft Visual C++ .NET version was also reported to
    1.17 +Compiler (g++), from version 3.3 upwards. We also checked the Intel C++
    1.18 +Compiler (icc). Microsoft Visual C++ .NET 2003 was also reported to
    1.19  work (but not the earlier versions). If you want to develop with LEMON
    1.20  under Windows you could consider using Cygwin.
    1.21  
    1.22 +In this description we will suppose a Linux environment and GNU C++ Compiler.
    1.23  
    1.24 -In this description we will suppose a linux environment and GNU C Compiler.
    1.25 +
    1.26 +\subsection requirementsLP LP solver requirements
    1.27 +
    1.28 +The LEMON LP solver interface can use the GLPK (GNU Linear Programming Kit)
    1.29 +and CPLEX solvers (was tested with CPLEX 7.5). If you want to use it you will
    1.30 +need at least one of these. See \ref configureFlags how to enable these at
    1.31 +compile time.
    1.32 +
    1.33 +
    1.34 +\subsection requirementsGUI GUI requirements
    1.35 +
    1.36 +To compile the graphical graph editor you will need libgnomecanvasmm
    1.37 +(2.6.0 or newer). See \ref configureFlags how to enable it.
    1.38 +
    1.39  
    1.40  \section downloadLEMON How to download LEMON
    1.41  
    1.42  You can download LEMON from the LEMON web site:
    1.43 -http://lemon.cs.elte.hu/download.html.
    1.44 +http://lemon.cs.elte.hu/download.html .
    1.45  There you will find released versions in form of <tt>.tar.gz</tt> files.
    1.46  If you want a developer version (for example you want to contribute in
    1.47  developing the library LEMON) then you might want to use our Subversion
    1.48 @@ -35,7 +50,6 @@
    1.49  you downloaded a tar.gz file.
    1.50  
    1.51  
    1.52 -
    1.53  \section installLEMON How to install LEMON
    1.54  
    1.55  In order to install LEMON you have to do the following steps.
    1.56 @@ -84,7 +98,6 @@
    1.57  ./configure
    1.58  \endverbatim
    1.59  Does some configuration (creates makefiles etc).
    1.60 -\todo Explain the most important switches here (gui, doc, glpk, cplex).
    1.61  
    1.62  \verbatim
    1.63  make
    1.64 @@ -106,7 +119,106 @@
    1.65  This will copy the directory structure to its final destination (e.g. to \c
    1.66  /usr/local) so that your system can access it. This command should
    1.67  be issued as "root", unless you provided a \c --prefix switch to
    1.68 -the \c cofugure to install the library in non-default location.
    1.69 +the \c configure to install the library in non-default location.
    1.70 +
    1.71 +
    1.72 +\subsection configureFlags Configure flags
    1.73 +
    1.74 +You can pass the following flags to \c ./configure (see \c ./configure --help
    1.75 +for more):
    1.76 +
    1.77 +\verbatim
    1.78 +--enable-gui
    1.79 +\endverbatim
    1.80 +Build the GUI.
    1.81 +
    1.82 +\verbatim
    1.83 +--disable-gui
    1.84 +\endverbatim
    1.85 +Do not build the GUI (default).
    1.86 +
    1.87 +\verbatim
    1.88 +--with-glpk[=PREFIX]
    1.89 +\endverbatim
    1.90 +Enable GLPK support (default). You should specify the prefix too if you
    1.91 +installed it to some non-standard location (e.g. your home directory). If
    1.92 +GLPK is not found, then GLPK support will be disabled.
    1.93 +
    1.94 +\verbatim
    1.95 +--with-glpk-includedir=DIR
    1.96 +\endverbatim
    1.97 +The directory where the GLPK header files are located. This is only useful when
    1.98 +the GLPK headers and libraries are not under the same prefix (which is not
    1.99 +likely).
   1.100 +
   1.101 +\verbatim
   1.102 +--with-glpk-libdir=DIR
   1.103 +\endverbatim
   1.104 +The directory where the GLPK libraries are located. This is only useful when
   1.105 +the GLPK headers and libraries are not under the same prefix (which is not
   1.106 +likely).
   1.107 +
   1.108 +\verbatim
   1.109 +--without-glpk
   1.110 +\endverbatim
   1.111 +Disable GLPK support.
   1.112 +
   1.113 +\verbatim
   1.114 +--with-cplex[=PREFIX]
   1.115 +\endverbatim
   1.116 +Enable CPLEX support (default). You should specify the prefix too if you
   1.117 +installed it to some non-standard location (e.g. \c /opt/ilog/cplex75). If
   1.118 +CPLEX is not found, then CPLEX support will be disabled.
   1.119 +
   1.120 +\verbatim
   1.121 +--with-cplex-includedir=DIR
   1.122 +\endverbatim
   1.123 +The directory where the CPLEX header files are located. This is only useful
   1.124 +when the CPLEX headers and libraries are not under the same prefix.
   1.125 +
   1.126 +\verbatim
   1.127 +--with-cplex-libdir=DIR
   1.128 +\endverbatim
   1.129 +The directory where the CPLEX libraries are located. This is only useful when
   1.130 +the CPLEX headers and libraries are not under the same prefix.
   1.131 +
   1.132 +\verbatim
   1.133 +--without-cplex
   1.134 +\endverbatim
   1.135 +Disable CPLEX support.
   1.136 +
   1.137 +
   1.138 +\section svnCheckout How to checkout LEMON form our Subversion repository
   1.139 +
   1.140 +You can obtain the latest version of LEMON from our Subversion repository. To
   1.141 +do this issue the following command:
   1.142 +\verbatim
   1.143 +svn co https://lemon.cs.elte.hu/svn/hugo/trunk lemon
   1.144 +\endverbatim
   1.145 +Use "lemon" as username, the password is empty.
   1.146 +
   1.147 +
   1.148 +\section svnCompile How to compile the source from the repository
   1.149 +
   1.150 +You can compile the code from the repository similarly to the packaged version,
   1.151 +but you will need to run \c ./bootstrap before \c ./configure. See \c
   1.152 +./bootstrap \c --help for options. For bootstrapping you will need the
   1.153 +following tools:
   1.154 +
   1.155 + - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
   1.156 + - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
   1.157 + - <a href="http://www.gnu.org/software/libtool/">libtool</a>
   1.158 + - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
   1.159 +
   1.160 +To generate the documentation, run \c make \c doc. You will need
   1.161 +<a href="http://www.doxygen.org/">Doxygen</a> for this.
   1.162 +
   1.163 +You can pass the \c --enable-doc=full flag to \c ./configure to generate the
   1.164 +internal documentation too.
   1.165 +
   1.166 +If you pass the \c --disable-doc flag to \c ./configure then the documentation
   1.167 +won't be installed, when you run \c make \c install (this speeds things up a
   1.168 +bit).
   1.169  
   1.170  \section helloworld My first program using LEMON
   1.171