Changeset 1637:9d64d5672b88 in lemon-0.x for doc/getstart.dox

Timestamp:

08/17/05 22:37:36 (20 years ago)

Author:

Akos Ladanyi

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2150

Message:

Added a section about configure flags, and a few other things.

File:

• doc/getstart.dox (modified) (5 diffs)

doc/getstart.dox

@@ -10 +10 @@
 <a href="http://lemon.cs.elte.hu/mailinglists.html">ask</a>.
 
+
 \section requirementsLEMON Hardware and software requirements
 
@@ -17 +18 @@
 
 You will need a recent C++ compiler. Our primary target is the GNU C++
-Compiler (g++), from version 3.3 upwards. We also checked the Intel C
-compiler (icc). Microsoft Visual C++ .NET version was also reported to
+Compiler (g++), from version 3.3 upwards. We also checked the Intel C++
+Compiler (icc). Microsoft Visual C++ .NET 2003 was also reported to
 work (but not the earlier versions). If you want to develop with LEMON
 under Windows you could consider using Cygwin.
 
-
-In this description we will suppose a linux environment and GNU C Compiler.
+In this description we will suppose a Linux environment and GNU C++ Compiler.
+
+
+\subsection requirementsLP LP solver requirements
+
+The LEMON LP solver interface can use the GLPK (GNU Linear Programming Kit)
+and CPLEX solvers (was tested with CPLEX 7.5). If you want to use it you will
+need at least one of these. See \ref configureFlags how to enable these at
+compile time.
+
+
+\subsection requirementsGUI GUI requirements
+
+To compile the graphical graph editor you will need libgnomecanvasmm
+(2.6.0 or newer). See \ref configureFlags how to enable it.
+
 
 \section downloadLEMON How to download LEMON
 
 You can download LEMON from the LEMON web site:
-http://lemon.cs.elte.hu/download.html.
+http://lemon.cs.elte.hu/download.html .
 There you will find released versions in form of <tt>.tar.gz</tt> files.
 If you want a developer version (for example you want to contribute in
@@ -34 +49 @@
 repository. This case is not detailed here, so from now on we suppose that
 you downloaded a tar.gz file.
-
 
 
@@ -85 +99 @@
 \endverbatim
 Does some configuration (creates makefiles etc).
-\todo Explain the most important switches here (gui, doc, glpk, cplex).
 
 \verbatim
@@ -107 +120 @@
 /usr/local) so that your system can access it. This command should
 be issued as "root", unless you provided a \c --prefix switch to
-the \c cofugure to install the library in non-default location.
+the \c configure to install the library in non-default location.
+
+
+\subsection configureFlags Configure flags
+
+You can pass the following flags to \c ./configure (see \c ./configure --help
+for more):
+
+\verbatim
+--enable-gui
+\endverbatim
+Build the GUI.
+
+\verbatim
+--disable-gui
+\endverbatim
+Do not build the GUI (default).
+
+\verbatim
+--with-glpk[=PREFIX]
+\endverbatim
+Enable GLPK support (default). You should specify the prefix too if you
+installed it to some non-standard location (e.g. your home directory). If
+GLPK is not found, then GLPK support will be disabled.
+
+\verbatim
+--with-glpk-includedir=DIR
+\endverbatim
+The directory where the GLPK header files are located. This is only useful when
+the GLPK headers and libraries are not under the same prefix (which is not
+likely).
+
+\verbatim
+--with-glpk-libdir=DIR
+\endverbatim
+The directory where the GLPK libraries are located. This is only useful when
+the GLPK headers and libraries are not under the same prefix (which is not
+likely).
+
+\verbatim
+--without-glpk
+\endverbatim
+Disable GLPK support.
+
+\verbatim
+--with-cplex[=PREFIX]
+\endverbatim
+Enable CPLEX support (default). You should specify the prefix too if you
+installed it to some non-standard location (e.g. \c /opt/ilog/cplex75). If
+CPLEX is not found, then CPLEX support will be disabled.
+
+\verbatim
+--with-cplex-includedir=DIR
+\endverbatim
+The directory where the CPLEX header files are located. This is only useful
+when the CPLEX headers and libraries are not under the same prefix.
+
+\verbatim
+--with-cplex-libdir=DIR
+\endverbatim
+The directory where the CPLEX libraries are located. This is only useful when
+the CPLEX headers and libraries are not under the same prefix.
+
+\verbatim
+--without-cplex
+\endverbatim
+Disable CPLEX support.
+
+
+\section svnCheckout How to checkout LEMON form our Subversion repository
+
+You can obtain the latest version of LEMON from our Subversion repository. To
+do this issue the following command:
+\verbatim
+svn co https://lemon.cs.elte.hu/svn/hugo/trunk lemon
+\endverbatim
+Use "lemon" as username, the password is empty.
+
+
+\section svnCompile How to compile the source from the repository
+
+You can compile the code from the repository similarly to the packaged version,
+but you will need to run \c ./bootstrap before \c ./configure. See \c
+./bootstrap \c --help for options. For bootstrapping you will need the
+following tools:
+
+ - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
+ - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
+ - <a href="http://www.gnu.org/software/libtool/">libtool</a>
+ - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
+
+To generate the documentation, run \c make \c doc. You will need
+<a href="http://www.doxygen.org/">Doxygen</a> for this.
+
+You can pass the \c --enable-doc=full flag to \c ./configure to generate the
+internal documentation too.
+
+If you pass the \c --disable-doc flag to \c ./configure then the documentation
+won't be installed, when you run \c make \c install (this speeds things up a
+bit).
 
 \section helloworld My first program using LEMON