# HG changeset patch # User ladanyi # Date 1124311056 0 # Node ID 9d64d5672b88df0214247dbf791e66093c58261f # Parent 260ac104190f2b3a67ba7263e1fe1e95adc7c7f9 Added a section about configure flags, and a few other things. diff -r 260ac104190f -r 9d64d5672b88 doc/getstart.dox --- a/doc/getstart.dox Wed Aug 17 15:26:00 2005 +0000 +++ b/doc/getstart.dox Wed Aug 17 20:37:36 2005 +0000 @@ -9,6 +9,7 @@ difficulties don't hesitate to ask. + \section requirementsLEMON Hardware and software requirements In LEMON we use C++ templates heavily, thus compilation takes a @@ -16,18 +17,32 @@ advantageous. But otherwise there are no special hardware requirements. 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 .tar.gz files. If you want a developer version (for example you want to contribute in developing the library LEMON) then you might want to use our Subversion @@ -35,7 +50,6 @@ you downloaded a tar.gz file. - \section installLEMON How to install LEMON In order to install LEMON you have to do the following steps. @@ -84,7 +98,6 @@ ./configure \endverbatim Does some configuration (creates makefiles etc). -\todo Explain the most important switches here (gui, doc, glpk, cplex). \verbatim make @@ -106,7 +119,106 @@ This will copy the directory structure to its final destination (e.g. to \c /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: + + - automake (1.7 or newer) + - autoconf (2.59 or newer) + - libtool + - pkgconfig + +To generate the documentation, run \c make \c doc. You will need +Doxygen 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