diff -r 4b3d55acc9d7 -r a48bf0d3a790 install.dox
--- a/install.dox Fri Oct 24 13:34:04 2008 +0100
+++ b/install.dox Tue Oct 28 18:54:30 2008 +0100
@@ -19,9 +19,9 @@
/**
\page install Installation Guide
-In this page we detail how to start using LEMON, from downloading it to
-your computer, through the steps of installation, to showing a simple
-"Hello World" type program that already uses LEMON. We assume that you
+In this section we detail how to start using LEMON, from downloading it
+to your computer, through the steps of installation, to showing how to
+compile programs that use LEMON. We assume that you
have a basic knowledge of your operating system and C++ programming
language. The procedure is pretty straightforward, but if you have any
difficulties do not hesitate to
@@ -41,10 +41,10 @@
In this description we will suppose a Linux environment and GNU C++ Compiler.
If you would like to develop under Windows and use a Windows installer,
-you could skip the following sections and continue reading \ref hello_lemon.
+you could skip the following sections and continue reading
+\ref basic_concepts.
However keep in mind that you have to make appropriate steps instead of
-the instructions detailed here to be able to compile the example code
-with your compiler.
+the instructions detailed here to be able to use LEMON with your compiler.
\subsection requirements_lp LP Solver Requirements
@@ -97,9 +97,6 @@
./configure --prefix=/home/username/lemon
\endverbatim
-In what follows we will assume that you were able to install to directory
-\c /usr/local, otherwise some extra care is to be taken to use the library.
-
We briefly explain these commands below.
\verbatim
@@ -144,10 +141,10 @@
Several other configure flags can be passed to ./configure.
For more information see the INSTALL file.
-\subsection install_hg Install the latest development version
+\subsection install_hg Install the Latest Development Version
You can also use the latest (developer) version of LEMON from our Mercurial
-repository. You need a couple additional tool for that
+repository. You need a couple additional tool for that.
- Mercurial
- for obtaining the latest code (and for contributing into it)
@@ -160,7 +157,7 @@
- for generating the documentations (optional, but recommended)
Once you have all these tools installed, the process is fairly easy.
-First, you have to get the copy of the lates version.
+First, you have to get the copy of the latest version.
\verbatim
hg clone http://lemon.cs.elte.hu/hg/lemon-main lemon-src
@@ -181,9 +178,55 @@
make install
\endverbatim
-To generate the documentation, just run
+To generate the documentation, just run
\verbatim
make html
\endverbatim
+\todo Is make html really necessary after
+make install?
+
+
+\section install_rpm Install from rpm
+
+\todo Write this section (\ref install_rpm).
+
+
+\section install_user Install Locally to the User
+
+\todo Write this section (\ref install_user).
+
+
+\section compile_codes Compile Codes that Use LEMON
+
+Now let us see how to use the library after installing it.
+
+\subsection compile_system_wide If LEMON is Installed System-Wide
+
+If your installation of LEMON into directory \c /usr/local was
+successful, then you have to issue a command like this to compile a
+source file that uses LEMON.
+
+\verbatim
+g++ -lemon [other options]
+\endverbatim
+
+The argument -lemon tells the compiler that we are using the
+installed library LEMON.
+
+\subsection compile_user_local If LEMON is Installed User-Local
+
+You have to give more options to the compiler if LEMON is installed
+user-local into a directory (denoted by )
+or if you just skipped the step make install.
+In the later case denotes the directory in which the
+the \c make command have been performed.
+
+\verbatim
+g++ -lemon -I -L /lemon/.libs [other options]
+\endverbatim
+
+\subsubsection compile_use_pkg_config Use pkg-config
+
+\todo Write this sub-subsection (\ref compile_use_pkg_config).
*/