COIN-OR::LEMON - Graph Library

Changeset 9:a48bf0d3a790 in lemon-tutorial


Ignore:
Timestamp:
10/28/08 18:54:30 (11 years ago)
Author:
Peter Kovacs <kpeter@…>
Branch:
default
Children:
10:55e2f7712e87, 11:0a51fe554d01
Phase:
public
Message:

Extend installation guide + reorganize the toc

Files:
3 edited

Legend:

Unmodified
Added
Removed
  • getting_started.dox

    r7 r9  
    1818
    1919/**
    20 \page getting_started Getting Started
    21 
    22 \section hello_lemon Compile Your First Code
     20\page hello_lemon Compile Your First Code
    2321
    2422If you have installed LEMON on your system you can paste the following
     
    3129
    3230First let us briefly explain how this example program works.
    33 (The used notions will be discussed in detail in the following chapter.)
     31(The used notions will be discussed in detail in the following sections.)
    3432
    3533After some convenience typedefs we create a directed graph (\e digraph)
     
    5351Finally we iterate through all arcs again and print their lengths.
    5452
    55 Now let's compile this simple example program.
     53Now let us compile this simple example program.
    5654
    57 \subsection hello_lemon_system If LEMON is Installed System-Wide
     55\section hello_lemon_system If LEMON is Installed System-Wide
    5856
    59 If your installation of LEMON into directory \c /usr/local was
    60 successful, then it is very easy to compile this program with the
     57If LEMON is installed system-wide (into directory \c /usr/local),
     58then it is very easy to compile this program with the
    6159following command (the argument <tt>-lemon</tt> tells the compiler
    6260that we are using the installed LEMON):
    6361
    6462\verbatim
    65 g++ hello_lemon.cc -o hello_lemon -lemon
     63g++ -lemon hello_lemon.cc -o hello_lemon
    6664\endverbatim
    6765
     
    7371\endverbatim
    7472
    75 \subsection hello_lemon_user If LEMON is Installed User-Local
     73\section hello_lemon_user If LEMON is Installed User-Local
    7674
    7775Compiling the code is a bit more difficult if you installed LEMON
     
    8179
    8280\verbatim
    83 g++ -I ~/lemon hello_lemon.cc -o hello_lemon -lemon -L ~/lemon/lemon/.libs
     81g++ -lemon -I ~/lemon -L ~/lemon/lemon/.libs hello_lemon.cc -o hello_lemon
    8482\endverbatim
    85 
    86 \subsubsection hello_lemon_pkg_config Use pkg-config
    87 
    88 \todo Write this sub-subsection (\ref hello_lemon_pkg_config).
    8983
    9084If everything has gone well, then our program prints out the followings.
  • install.dox

    r7 r9  
    2020\page install Installation Guide
    2121
    22 In this page we detail how to start using LEMON, from downloading it to
    23 your computer, through the steps of installation, to showing a simple
    24 "Hello World" type program that already uses LEMON. We assume that you
     22In this section we detail how to start using LEMON, from downloading it
     23to your computer, through the steps of installation, to showing how to
     24compile programs that use LEMON. We assume that you
    2525have a basic knowledge of your operating system and C++ programming
    2626language. The procedure is pretty straightforward, but if you have any
     
    4242In this description we will suppose a Linux environment and GNU C++ Compiler.
    4343If you would like to develop under Windows and use a Windows installer,
    44 you could skip the following sections and continue reading \ref hello_lemon.
     44you could skip the following sections and continue reading
     45\ref basic_concepts.
    4546However keep in mind that you have to make appropriate steps instead of
    46 the instructions detailed here to be able to compile the example code
    47 with your compiler.
     47the instructions detailed here to be able to use LEMON with your compiler.
    4848
    4949\subsection requirements_lp LP Solver Requirements
     
    9898\endverbatim
    9999
    100 In what follows we will assume that you were able to install to directory
    101 \c /usr/local, otherwise some extra care is to be taken to use the library.
    102 
    103100We briefly explain these commands below.
    104101
     
    145142For more information see the <b><tt>INSTALL</tt></b> file.
    146143
    147 \subsection install_hg Install the latest development version
     144\subsection install_hg Install the Latest Development Version
    148145
    149146You can also use the latest (developer) version of LEMON from our Mercurial
    150 repository. You need a couple additional tool for that
     147repository. You need a couple additional tool for that.
    151148
    152149- <a href="http://www.selenic.com/mercurial">Mercurial</a>
     
    161158
    162159Once you have all these tools installed, the process is fairly easy.
    163 First, you have to get the copy of the lates version.
     160First, you have to get the copy of the latest version.
    164161
    165162\verbatim
     
    182179\endverbatim
    183180
    184 To generate the documentation, just run 
     181To generate the documentation, just run
    185182\verbatim
    186183make html
    187184\endverbatim
     185\todo Is <tt><b>make html</b></tt> really necessary after
     186<tt><b>make install</b></tt>?
     187
     188
     189\section install_rpm Install from rpm
     190
     191\todo Write this section (\ref install_rpm).
     192
     193
     194\section install_user Install Locally to the User
     195
     196\todo Write this section (\ref install_user).
     197
     198
     199\section compile_codes Compile Codes that Use LEMON
     200
     201Now let us see how to use the library after installing it.
     202
     203\subsection compile_system_wide If LEMON is Installed System-Wide
     204
     205If your installation of LEMON into directory \c /usr/local was
     206successful, then you have to issue a command like this to compile a
     207source file that uses LEMON.
     208
     209\verbatim
     210g++ -lemon [other options] <source file>
     211\endverbatim
     212
     213The argument <tt>-lemon</tt> tells the compiler that we are using the
     214installed library LEMON.
     215
     216\subsection compile_user_local If LEMON is Installed User-Local
     217
     218You have to give more options to the compiler if LEMON is installed
     219user-local into a directory (denoted by <tt><dir></tt>)
     220or if you just skipped the step <tt>make install</tt>.
     221In the later case <tt><dir></tt> denotes the directory in which the
     222the \c make command have been performed.
     223
     224\verbatim
     225g++ -lemon -I <dir> -L <dir>/lemon/.libs [other options] <source file>
     226\endverbatim
     227
     228\subsubsection compile_use_pkg_config Use pkg-config
     229
     230\todo Write this sub-subsection (\ref compile_use_pkg_config).
    188231
    189232*/
  • mainpage.dox

    r7 r9  
    2424
    2525 - \ref intro
    26  - \ref getting_started
     26 - \ref basic_concepts "Basic Concepts"
    2727   - \ref hello_lemon
    28  - \ref basic_concepts "Basic Concepts"
    2928   - \ref digraph_build "Build and Modify a Digraph"
    3029   - \ref digraph_iterate "Iterate Over the Elements"
     
    6059       - \ref requirements_lp
    6160     - \ref install_from_source
    62      - \ref install_system_rpm "From rpm"
    63      - \ref install_user "Install Locally to the User"
     61       - \ref install_hg
     62     - \ref install_rpm
     63     - \ref install_user
     64     - \ref compile_codes
     65       - \ref compile_system_wide
     66       - \ref compile_user_local
    6467
    6568*/
Note: See TracChangeset for help on using the changeset viewer.