# HG changeset patch # User Alpar Juttner # Date 2008-01-03 11:12:27 # Node ID 40d6f625e549fabdc92788f7cdb20aceea5f8b78 # Parent 5e9f3d3c115b4b089a982defedb7352f1b0ba70c # Parent 099a4f1844f193fcec8d5a3d40814f55ab1fe87b Merge diff --git a/INSTALL b/INSTALL new file mode 100644 --- /dev/null +++ b/INSTALL @@ -0,0 +1,117 @@ +Installation Instructions +========================= + + Since you are reading this I assume you already obtained one of the release +tarballs and successfully extracted it. The latest version of LEMON is +available at our webpage (http://lemon.cs.elte.hu/). + + In order to install LEMON from the extracted source tarball you have to +issue the following commands: + + 1. `cd lemon-x.y.z' + + This changes to the directory which was created when you extracted the + sources. The x.y.z part is a version number. + + 2. `./configure' + + This runs the configure shell script, which does some checks and + configuration (creates makefiles etc). + + 3. `make' + + This command compiles the non-template part of LEMON into libemon.a file. + It also compiles the benchmark and demo programs when enabled. + + 4. `make check' + + This step is optional, but recommended. It runs the test programs that we + developed for LEMON to check whether the library works properly on your + platform. + + 5. `make install' + + This command installs LEMON under /usr/local (you will need root + privileges to be able to do that). If you want to install it to some + other location, then pass the --prefix=DIRECTORY flag to configure in + step 1. For example: `./configure --prefix=/home/username/lemon' + + +Configure Flags +=============== + + You can pass the following flags to configure in step 1 +(see ./configure --help for more): + +CXX=comp + + Change the C++ compiler to 'comp'. + +CXXFLAGS='flags' + + Pass the 'flags' to the compiler. For example + CXXFLAGS='-O3 -march=pentium-m' + turns on generation of aggressively optimized + Pentium-M specific code. + +--enable-demo + + Build the demo programs too. + +--disable-demo + + Do not build the demo programs (default). + +--enable-benchmark + + Build the benchmark programs too. + +--disable-benchmark + + Do not build the benchmark programs (default). + +--with-glpk[=PREFIX] + + Enable GLPK support (default). You should specify the prefix too if + you installed GLPK to some non-standard location (e.g. your home + directory). If it is not found, GLPK support will be disabled. + +--with-glpk-includedir=DIR + + 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 unlikely). + +--with-glpk-libdir=DIR + + 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 unlikely). + +--without-glpk + + Disable GLPK support. + +--with-cplex[=PREFIX] + + Enable CPLEX support (default). You should specify the prefix too + if you installed CPLEX to some non-standard location + (e.g. /opt/ilog/cplex75). If it is not found, CPLEX support will be + disabled. + +--with-cplex-includedir=DIR + + 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 (e.g. /usr/local/cplex/cplex75/include). + +--with-cplex-libdir=DIR + + The directory where the CPLEX libraries are located. This is only + useful when the CPLEX headers and libraries are not under the same + prefix (e.g. + /usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt). + +--without-cplex + + Disable CPLEX support. diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,33 @@ +LEMON code without an explicit copyright is covered by the following +copyright/license. + +Copyright (C) 2003-2007 Egervary Jeno Kombinatorikus Optimalizalasi +Kutatocsoport (Egervary Combinatorial Optimization Research Group, +EGRES). + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. + +=========================================================================== +This license is a verbatim copy of the Boost Software License, Version 1.0. + + diff --git a/Makefile.am b/Makefile.am --- a/Makefile.am +++ b/Makefile.am @@ -4,6 +4,7 @@ LDADD = $(top_builddir)/lemon/libemon.la EXTRA_DIST = \ + LICENSE \ m4/lx_check_cplex.m4 \ m4/lx_check_glpk.m4 \ m4/lx_check_soplex.m4 diff --git a/NEWS b/NEWS new file mode 100644 diff --git a/README b/README new file mode 100644 --- /dev/null +++ b/README @@ -0,0 +1,60 @@ +------------------------------------------------------------------ +LEMON - a Library of Efficient Models and Optimization in Networks +------------------------------------------------------------------ + +LEMON is the abbreviation of Library of Efficient Models and +Optimization in Networks. It is an open source library written in +C++. It provides a set of easy-to-use implementation of common data +structures and algorithms in the area of optimization and helps +implementing new ones. It is an especially suitable tool to solve the +design and optimization problems of telecommunications networks. To +achieve wide usability, a fundamental design requirement is the +genericity of interface of data structures and algorithms. LEMON is an +open source library end invites people all around the world in its +development. + +-------- +Contents +-------- + +COPYING, LICENSE + + Copying, distribution and modification conditions and terms. + +INSTALL + + For general building and installation instructions, see the file + +lemon/ + + Source code of LEMON itself. + +doc/ + + Documentation of LEMON. The starting page is doc/html/index/html. + The documentation installs into the directory + + /usr/local/share/doc/lemon/html + + or -- if you use different prefix -- into + + ${prefix}/share/doc/lemon/html + + (see also INSTALL). + +demo/ + + Some demonstration programs to make you easier to getting familiar + with LEMON. Use --enable-demo configure option to also compile these + codes (see also INSTALL). + +test/ + + Contains programs to check the integrity and correctness of + LEMON. The command 'make check' performs these tests. + +benchmark/ + + Contains programs measuring the performance of LEMON. Use + --enable-benchmark configure option to also compile these codes (see + also INSTALL).