General information and legal files ported from svn -r3424
authorAlpar Juttner <alpar@cs.elte.hu>
Sun, 23 Dec 2007 08:25:34 +0000
changeset 5233b4094ceae
parent 4 3f411aa35bd7
child 6 099a4f1844f1
General information and legal files ported from svn -r3424
INSTALL
LICENSE
Makefile.am
NEWS
README
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/INSTALL	Sun Dec 23 08:25:34 2007 +0000
     1.3 @@ -0,0 +1,117 @@
     1.4 +Installation Instructions
     1.5 +=========================
     1.6 +
     1.7 +   Since you are reading this I assume you already obtained one of the release
     1.8 +tarballs and successfully extracted it. The latest version of LEMON is
     1.9 +available at our webpage (http://lemon.cs.elte.hu/).
    1.10 +
    1.11 +   In order to install LEMON from the extracted source tarball you have to
    1.12 +issue the following commands:
    1.13 +
    1.14 +  1. `cd lemon-x.y.z'
    1.15 +
    1.16 +     This changes to the directory which was created when you extracted the
    1.17 +     sources. The x.y.z part is a version number.
    1.18 +
    1.19 +  2. `./configure'
    1.20 +
    1.21 +     This runs the configure shell script, which does some checks and
    1.22 +     configuration (creates makefiles etc).
    1.23 +
    1.24 +  3. `make'
    1.25 +
    1.26 +     This command compiles the non-template part of LEMON into libemon.a file.
    1.27 +     It also compiles the benchmark and demo programs when enabled.
    1.28 +
    1.29 +  4. `make check'
    1.30 +
    1.31 +     This step is optional, but recommended. It runs the test programs that we
    1.32 +     developed for LEMON to check whether the library works properly on your
    1.33 +     platform.
    1.34 +
    1.35 +  5. `make install'
    1.36 +
    1.37 +     This command installs LEMON under /usr/local (you will need root
    1.38 +     privileges to be able to do that). If you want to install it to some
    1.39 +     other location, then pass the --prefix=DIRECTORY flag to configure in
    1.40 +     step 1. For example: `./configure --prefix=/home/username/lemon'
    1.41 +
    1.42 +
    1.43 +Configure Flags
    1.44 +===============
    1.45 +
    1.46 +   You can pass the following flags to configure in step 1
    1.47 +(see ./configure --help for more):
    1.48 +
    1.49 +CXX=comp
    1.50 +
    1.51 +  Change the C++ compiler to 'comp'.
    1.52 +
    1.53 +CXXFLAGS='flags'
    1.54 +
    1.55 +  Pass the 'flags' to the compiler. For example
    1.56 +  CXXFLAGS='-O3 -march=pentium-m'
    1.57 +  turns  on generation of aggressively optimized
    1.58 +  Pentium-M specific code.
    1.59 +
    1.60 +--enable-demo
    1.61 +
    1.62 +   Build the demo programs too.
    1.63 +
    1.64 +--disable-demo
    1.65 +
    1.66 +   Do not build the demo programs (default).
    1.67 +
    1.68 +--enable-benchmark
    1.69 +
    1.70 +   Build the benchmark programs too.
    1.71 +
    1.72 +--disable-benchmark
    1.73 +
    1.74 +   Do not build the benchmark programs (default).
    1.75 +
    1.76 +--with-glpk[=PREFIX]
    1.77 +
    1.78 +   Enable GLPK support (default). You should specify the prefix too if
    1.79 +   you installed GLPK to some non-standard location (e.g. your home
    1.80 +   directory). If it is not found, GLPK support will be disabled.
    1.81 +
    1.82 +--with-glpk-includedir=DIR
    1.83 +
    1.84 +   The directory where the GLPK header files are located. This is only
    1.85 +   useful when the GLPK headers and libraries are not under the same
    1.86 +   prefix (which is unlikely).
    1.87 +
    1.88 +--with-glpk-libdir=DIR
    1.89 +
    1.90 +   The directory where the GLPK libraries are located. This is only
    1.91 +   useful when the GLPK headers and libraries are not under the same
    1.92 +   prefix (which is unlikely).
    1.93 +
    1.94 +--without-glpk
    1.95 +
    1.96 +   Disable GLPK support.
    1.97 +
    1.98 +--with-cplex[=PREFIX]
    1.99 +
   1.100 +   Enable CPLEX support (default). You should specify the prefix too
   1.101 +   if you installed CPLEX to some non-standard location
   1.102 +   (e.g. /opt/ilog/cplex75). If it is not found, CPLEX support will be
   1.103 +   disabled.
   1.104 +
   1.105 +--with-cplex-includedir=DIR
   1.106 +
   1.107 +   The directory where the CPLEX header files are located. This is
   1.108 +   only useful when the CPLEX headers and libraries are not under the
   1.109 +   same prefix (e.g.  /usr/local/cplex/cplex75/include).
   1.110 +
   1.111 +--with-cplex-libdir=DIR
   1.112 +
   1.113 +   The directory where the CPLEX libraries are located. This is only
   1.114 +   useful when the CPLEX headers and libraries are not under the same
   1.115 +   prefix (e.g.
   1.116 +   /usr/local/cplex/cplex75/lib/i86_linux2_glibc2.2_gcc3.0/static_pic_mt).
   1.117 +
   1.118 +--without-cplex
   1.119 +
   1.120 +   Disable CPLEX support.
     2.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     2.2 +++ b/LICENSE	Sun Dec 23 08:25:34 2007 +0000
     2.3 @@ -0,0 +1,33 @@
     2.4 +LEMON code without an explicit copyright is covered by the following
     2.5 +copyright/license.
     2.6 +
     2.7 +Copyright (C) 2003-2007 Egervary Jeno Kombinatorikus Optimalizalasi
     2.8 +Kutatocsoport (Egervary Combinatorial Optimization Research Group,
     2.9 +EGRES).
    2.10 +
    2.11 +Permission is hereby granted, free of charge, to any person or organization
    2.12 +obtaining a copy of the software and accompanying documentation covered by
    2.13 +this license (the "Software") to use, reproduce, display, distribute,
    2.14 +execute, and transmit the Software, and to prepare derivative works of the
    2.15 +Software, and to permit third-parties to whom the Software is furnished to
    2.16 +do so, all subject to the following:
    2.17 +
    2.18 +The copyright notices in the Software and this entire statement, including
    2.19 +the above license grant, this restriction and the following disclaimer,
    2.20 +must be included in all copies of the Software, in whole or in part, and
    2.21 +all derivative works of the Software, unless such copies or derivative
    2.22 +works are solely in the form of machine-executable object code generated by
    2.23 +a source language processor.
    2.24 +
    2.25 +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    2.26 +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    2.27 +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
    2.28 +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
    2.29 +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
    2.30 +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
    2.31 +DEALINGS IN THE SOFTWARE.
    2.32 +
    2.33 +===========================================================================
    2.34 +This license is a verbatim copy of the Boost Software License, Version 1.0.
    2.35 +
    2.36 +
     3.1 --- a/Makefile.am	Wed Dec 19 11:33:49 2007 +0000
     3.2 +++ b/Makefile.am	Sun Dec 23 08:25:34 2007 +0000
     3.3 @@ -4,6 +4,7 @@
     3.4  LDADD = $(top_builddir)/lemon/libemon.la
     3.5  
     3.6  EXTRA_DIST = \
     3.7 +	LICENSE \
     3.8  	m4/lx_check_cplex.m4 \
     3.9  	m4/lx_check_glpk.m4 \
    3.10  	m4/lx_check_soplex.m4
     4.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     4.2 +++ b/README	Sun Dec 23 08:25:34 2007 +0000
     4.3 @@ -0,0 +1,60 @@
     4.4 +------------------------------------------------------------------
     4.5 +LEMON - a Library of Efficient Models and Optimization in Networks
     4.6 +------------------------------------------------------------------
     4.7 +
     4.8 +LEMON is the abbreviation of Library of Efficient Models and
     4.9 +Optimization in Networks. It is an open source library written in
    4.10 +C++. It provides a set of easy-to-use implementation of common data
    4.11 +structures and algorithms in the area of optimization and helps
    4.12 +implementing new ones. It is an especially suitable tool to solve the
    4.13 +design and optimization problems of telecommunications networks. To
    4.14 +achieve wide usability, a fundamental design requirement is the
    4.15 +genericity of interface of data structures and algorithms. LEMON is an
    4.16 +open source library end invites people all around the world in its
    4.17 +development.
    4.18 +
    4.19 +--------
    4.20 +Contents
    4.21 +--------
    4.22 +
    4.23 +COPYING, LICENSE
    4.24 +
    4.25 +  Copying, distribution and modification conditions and terms.
    4.26 +
    4.27 +INSTALL
    4.28 +
    4.29 +  For general building and installation instructions, see the file
    4.30 +
    4.31 +lemon/
    4.32 +
    4.33 +  Source code of LEMON itself.
    4.34 +
    4.35 +doc/
    4.36 +
    4.37 +  Documentation of LEMON. The starting page is doc/html/index/html.
    4.38 +  The documentation installs into the directory
    4.39 +
    4.40 +    /usr/local/share/doc/lemon/html
    4.41 +
    4.42 +  or -- if you use different prefix -- into
    4.43 +
    4.44 +    ${prefix}/share/doc/lemon/html
    4.45 +
    4.46 +  (see also INSTALL).
    4.47 +
    4.48 +demo/
    4.49 +
    4.50 +  Some demonstration programs to make you easier to getting familiar
    4.51 +  with LEMON. Use --enable-demo configure option to also compile these
    4.52 +  codes (see also INSTALL).
    4.53 +
    4.54 +test/
    4.55 +
    4.56 +  Contains programs to check the integrity and correctness of
    4.57 +  LEMON. The command 'make check' performs these tests.
    4.58 +
    4.59 +benchmark/
    4.60 +  
    4.61 +  Contains programs measuring the performance of LEMON. Use
    4.62 +  --enable-benchmark configure option to also compile these codes (see
    4.63 +  also INSTALL).