1.1 --- a/INSTALL Fri Jul 14 10:50:05 2006 +0000
1.2 +++ b/INSTALL Fri Jul 14 10:51:14 2006 +0000
1.3 @@ -40,65 +40,78 @@
1.4 Configure Flags
1.5 ===============
1.6
1.7 - You can pass the following flags to configure in step 1 (see ./configure
1.8 ---help for more):
1.9 + You can pass the following flags to configure in step 1
1.10 +(see ./configure --help for more):
1.11
1.12 - --with-glpk[=PREFIX]
1.13 +CXX=comp
1.14
1.15 - Enable GLPK support (default). You should specify the prefix too if you
1.16 -installed GLPK to some non-standard location (e.g. your home directory). If it
1.17 -is not found, GLPK support will be disabled.
1.18 + Change the C++ compiler to 'comp'.
1.19
1.20 - --with-glpk-includedir=DIR
1.21 +CXXFLAGS='flags'
1.22
1.23 - The directory where the GLPK header files are located. This is only useful
1.24 -when the GLPK headers and libraries are not under the same prefix (which is
1.25 -unlikely).
1.26 + Pass the 'flags' to the compiler. For example
1.27 + CXXFLAGS='-O3 -march=pentium-m'
1.28 + turns on generation of aggressively optimized
1.29 + Pentium-M specific code.
1.30
1.31 - --with-glpk-libdir=DIR
1.32 +--enable-demo
1.33
1.34 - The directory where the GLPK libraries are located. This is only useful
1.35 -when the GLPK headers and libraries are not under the same prefix (which is
1.36 -unlikely).
1.37 + Build the demo programs too.
1.38
1.39 - --without-glpk
1.40 +--disable-demo
1.41 +
1.42 + Do not build the demo programs (default).
1.43 +
1.44 +--enable-benchmark
1.45 +
1.46 + Build the benchmark programs too.
1.47 +
1.48 +--disable-benchmark
1.49 +
1.50 + Do not build the benchmark programs (default).
1.51 +
1.52 +--with-glpk[=PREFIX]
1.53 +
1.54 + Enable GLPK support (default). You should specify the prefix too if
1.55 + you installed GLPK to some non-standard location (e.g. your home
1.56 + directory). If it is not found, GLPK support will be disabled.
1.57 +
1.58 +--with-glpk-includedir=DIR
1.59 +
1.60 + The directory where the GLPK header files are located. This is only
1.61 + useful when the GLPK headers and libraries are not under the same
1.62 + prefix (which is unlikely).
1.63 +
1.64 +--with-glpk-libdir=DIR
1.65 +
1.66 + The directory where the GLPK libraries are located. This is only
1.67 + useful when the GLPK headers and libraries are not under the same
1.68 + prefix (which is unlikely).
1.69 +
1.70 +--without-glpk
1.71
1.72 Disable GLPK support.
1.73
1.74 - --with-cplex[=PREFIX]
1.75 +--with-cplex[=PREFIX]
1.76
1.77 - Enable CPLEX support (default). You should specify the prefix too if you
1.78 -installed CPLEX to some non-standard location (e.g. /opt/ilog/cplex75). If it
1.79 -is not found, CPLEX support will be disabled.
1.80 + Enable CPLEX support (default). You should specify the prefix too
1.81 + if you installed CPLEX to some non-standard location
1.82 + (e.g. /opt/ilog/cplex75). If it is not found, CPLEX support will be
1.83 + disabled.
1.84
1.85 - --with-cplex-includedir=DIR
1.86 +--with-cplex-includedir=DIR
1.87
1.88 - The directory where the CPLEX header files are located. This is only useful
1.89 -when the CPLEX headers and libraries are not under the same prefix (e.g.
1.90 -/usr/local/cplex/cplex75/include).
1.91 + The directory where the CPLEX header files are located. This is
1.92 + only useful when the CPLEX headers and libraries are not under the
1.93 + same prefix (e.g. /usr/local/cplex/cplex75/include).
1.94
1.95 - --with-cplex-libdir=DIR
1.96 +--with-cplex-libdir=DIR
1.97
1.98 - The directory where the CPLEX libraries are located. This is only useful
1.99 -when the CPLEX headers and libraries are not under the same prefix (e.g.
1.100 -/usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt).
1.101 + The directory where the CPLEX libraries are located. This is only
1.102 + useful when the CPLEX headers and libraries are not under the same
1.103 + prefix (e.g.
1.104 + /usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt).
1.105
1.106 - --without-cplex
1.107 +--without-cplex
1.108
1.109 Disable CPLEX support.
1.110 -
1.111 - --enable-demo
1.112 -
1.113 - Build the demo programs too.
1.114 -
1.115 - --disable-demo
1.116 -
1.117 - Do not build the demo programs (default).
1.118 -
1.119 - --enable-benchmark
1.120 -
1.121 - Build the benchmark programs too.
1.122 -
1.123 - --disable-benchmark
1.124 -
1.125 - Do not build the benchmark programs (default).
2.1 --- a/README Fri Jul 14 10:50:05 2006 +0000
2.2 +++ b/README Fri Jul 14 10:51:14 2006 +0000
2.3 @@ -1,36 +1,60 @@
2.4 -LEMON
2.5 +------------------------------------------------------------------
2.6 +LEMON - a Library of Efficient Models and Optimization in Networks
2.7 +------------------------------------------------------------------
2.8
2.9 -Library of Efficient Models and Optimization in Networks
2.10 +LEMON is the abbreviation of Library of Efficient Models and
2.11 +Optimization in Networks. It is an open source library written in
2.12 +C++. It provides a set of easy-to-use implementation of common data
2.13 +structures and algorithms in the area of optimization and helps
2.14 +implementing new ones. It is an especially suitable tool to solve the
2.15 +design and optimization problems of telecommunications networks. To
2.16 +achieve wide usability, a fundamental design requirement is the
2.17 +genericity of interface of data structures and algorithms. Lemon is
2.18 +intended to become an open source library in order to involve people
2.19 +all around the world in its development.
2.20
2.21 -LEMON is the abbreviation of Library of Efficient Models
2.22 -and Optimization in Networks. It is an open source
2.23 -library written in C++. It provides a set of easy-to-use
2.24 -implementation of common data structures and algorithms
2.25 -in the area of optimization and helps implementing new
2.26 -ones. It is an especially suitable tool to solve the
2.27 -design and optimization problems of telecommunications
2.28 -networks. To achieve wide usability, a fundamental design
2.29 -requirement is the genericity of interface of data
2.30 -structures and algorithms. Lemon is intended to become an
2.31 -open source library in order to involve people all around
2.32 -the world in its development.
2.33 +--------
2.34 +Contents
2.35 +--------
2.36
2.37 -The subdirectories 'autopackage', 'build-aux' and 'm4' are
2.38 -needed by installation. In subdirectory 'benchmark'
2.39 -programs can be found that observe the performance of LEMON.
2.40 -Subdirectory 'demo' contains some demonstration programs to
2.41 -make you easier to getting familiar with LEMON. Documentation
2.42 -of LEMON can be found in subdirectory 'doc'. Source code of
2.43 -LEMON is in subdirectory 'lemon'. Some useful scripts related
2.44 -to the usage of LEMON can be found in subdirectory 'scripts'.
2.45 -In subdirectory 'test' you can find some programs, proofing
2.46 -you the correctness of some implementations.
2.47 +COPYING, LICENSE
2.48
2.49 -See file COPYING for copying, distribution and modification
2.50 -conditions and terms.
2.51 + Copying, distribution and modification conditions and terms.
2.52
2.53 -For general building and installation instructions, see the
2.54 -file INSTALL.
2.55 +INSTALL
2.56
2.57 -Version number of the package is the highest one written in
2.58 -file NEWS.
2.59 + For general building and installation instructions, see the file
2.60 +
2.61 +lemon/
2.62 +
2.63 + Source code of LEMON itself.
2.64 +
2.65 +doc/
2.66 +
2.67 + Documentation of LEMON. The staring page is doc/html/index/html.
2.68 + The documentation will be installed into the directory
2.69 +
2.70 + /usr/local/share/doc/lemon/html
2.71 +
2.72 + or -- if you use different prefix -- into
2.73 +
2.74 + ${prefix}/share/doc/lemon/html
2.75 +
2.76 + (see also INSTALL).
2.77 +
2.78 +demo/
2.79 +
2.80 + Some demonstration programs to make you easier to getting familiar
2.81 + with LEMON. Use --enable-demo configure option to also compile these
2.82 + codes (see also INSTALL).
2.83 +
2.84 +test/
2.85 +
2.86 + Contains programs to check the integrity and correctness of
2.87 + LEMON. The command 'make check' performs these tests.
2.88 +
2.89 +benchmark/
2.90 +
2.91 + Contains programs measuring the performance of LEMON. Use
2.92 + --enable-benchmark configure option to also compile these codes (see
2.93 + also INSTALL).