doc/getstart.dox
changeset 2473 9ffff9051a4b
parent 2395 fe5966d8acfc
child 2553 bfced05fa852
equal deleted inserted replaced
15:1c0fd1f2d4d6 16:3156a7dae689
    52 
    52 
    53 
    53 
    54 \section downloadLEMON How to download LEMON
    54 \section downloadLEMON How to download LEMON
    55 
    55 
    56 You can download LEMON from the LEMON web site:
    56 You can download LEMON from the LEMON web site:
    57 <a href="http://lemon.cs.elte.hu/site/products/">
    57 <a href="https://lemon.cs.elte.hu/site/products/">
    58 http://lemon.cs.elte.hu/site/products/</a> .
    58 https://lemon.cs.elte.hu/site/products/</a> .
    59 There you will find released versions in form of <tt>.tar.gz</tt> files.
    59 There you will find released versions in form of <tt>.tar.gz</tt> files.
    60 If you want a developer version (for example you want to contribute in
    60 If you want a developer version (for example you want to contribute in
    61 developing the library LEMON) then you might want to use our Subversion
    61 developing the library LEMON) then you might want to use our Subversion
    62 repository. This case is not detailed here, so from now on we suppose that
    62 repository. This case is detailed later, so from now on we suppose that
    63 you downloaded a tar.gz file.
    63 you downloaded a <tt>.tar.gz</tt> file.
    64 
    64 
    65 
    65 
    66 \section installLEMON How to install LEMON
    66 \section installLEMON How to install LEMON
    67 
    67 
    68 In order to install LEMON you have to do the following steps.
    68 In order to install LEMON you have to do the following steps.
    82 \endverbatim
    82 \endverbatim
    83 
    83 
    84 These commands install LEMON under \c /usr/local (you will
    84 These commands install LEMON under \c /usr/local (you will
    85 need root privileges to be able to install to that
    85 need root privileges to be able to install to that
    86 directory). If you want to install it to some other place, then
    86 directory). If you want to install it to some other place, then
    87 pass the \c --prefix=DIRECTORY flag to \c ./configure, for example:
    87 pass the \c --prefix=DIRECTORY flag to <tt>./configure</tt>, for example:
    88 
    88 
    89 \verbatim
    89 \verbatim
    90 ./configure --prefix=/home/username/lemon
    90 ./configure --prefix=/home/username/lemon
    91 \endverbatim
    91 \endverbatim
    92 
    92 
   135 the \c configure to install the library in non-default location.
   135 the \c configure to install the library in non-default location.
   136 
   136 
   137 
   137 
   138 \subsection configureFlags Configure flags
   138 \subsection configureFlags Configure flags
   139 
   139 
   140 You can pass the following flags to \c ./configure (see \c ./configure --help
   140 You can pass the following flags to <tt>./configure</tt> (see <tt>./configure</tt> --help
   141 for more):
   141 for more):
   142 
   142 
   143 \verbatim
   143 \verbatim
   144 --with-glpk[=PREFIX]
   144 --with-glpk[=PREFIX]
   145 \endverbatim
   145 \endverbatim
   227 
   227 
   228 \section svnCompile How to compile the source from the repository
   228 \section svnCompile How to compile the source from the repository
   229 
   229 
   230 You can compile the code from the repository similarly to the packaged
   230 You can compile the code from the repository similarly to the packaged
   231 version, but you will need to run \c autoreconf \c -vi or 
   231 version, but you will need to run \c autoreconf \c -vi or 
   232 \c ./bootstrap in some older environment before \c ./configure. See \c
   232 <tt>./bootstrap</tt> in some older environment before <tt>./configure</tt>. See \c
   233 ./configure \c --help for options. For bootstrapping you will need the
   233 ./configure \c --help for options. For bootstrapping you will need the
   234 following tools:
   234 following tools:
   235 
   235 
   236  - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
   236  - <a href="http://www.gnu.org/software/automake/">automake</a> (1.7 or newer)
   237  - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
   237  - <a href="http://www.gnu.org/software/autoconf/">autoconf</a> (2.59 or newer)
   239  - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
   239  - <a href="http://pkgconfig.freedesktop.org/">pkgconfig</a>
   240 
   240 
   241 To generate the documentation, run \c make \c doc. You will need
   241 To generate the documentation, run \c make \c doc. You will need
   242 <a href="http://www.doxygen.org/">Doxygen</a> for this.
   242 <a href="http://www.doxygen.org/">Doxygen</a> for this.
   243 
   243 
   244 You can pass the \c --enable-doc=full flag to \c ./configure to generate the
   244 You can pass the \c --enable-doc=full flag to <tt>./configure</tt> to generate the
   245 internal documentation too.
   245 internal documentation too.
   246 
   246 
   247 If you pass the \c --disable-doc flag to \c ./configure then the documentation
   247 If you pass the \c --disable-doc flag to <tt>./configure</tt> then the documentation
   248 won't be installed, when you run \c make \c install (this speeds things up a
   248 won't be installed, when you run \c make \c install (this speeds things up a
   249 bit).
   249 bit).
   250 
   250 
   251 \section helloworld My first program using LEMON
   251 \section helloworld My first program using LEMON
   252 
   252 
   304 
   304 
   305 Congratulations!
   305 Congratulations!
   306 
   306 
   307 If you want to see more features, go to the
   307 If you want to see more features, go to the
   308 \ref quicktour "Quick Tour to LEMON",
   308 \ref quicktour "Quick Tour to LEMON",
   309 if you want to see see some demo programs then go to our 
   309 if you want to see some demo programs then go to our 
   310 \ref demoprograms "Demo Programs" page! 
   310 \ref demoprograms "Demo Programs" page! 
   311 
   311 
   312 
   312 
   313 */
   313 */