1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Thu Jan 03 11:12:27 2008 +0100
     1.3 @@ -0,0 +1,60 @@
     1.4 +------------------------------------------------------------------
     1.5 +LEMON - a Library of Efficient Models and Optimization in Networks
     1.6 +------------------------------------------------------------------
     1.7 +
     1.8 +LEMON is the abbreviation of Library of Efficient Models and
     1.9 +Optimization in Networks. It is an open source library written in
    1.10 +C++. It provides a set of easy-to-use implementation of common data
    1.11 +structures and algorithms in the area of optimization and helps
    1.12 +implementing new ones. It is an especially suitable tool to solve the
    1.13 +design and optimization problems of telecommunications networks. To
    1.14 +achieve wide usability, a fundamental design requirement is the
    1.15 +genericity of interface of data structures and algorithms. LEMON is an
    1.16 +open source library end invites people all around the world in its
    1.17 +development.
    1.18 +
    1.19 +--------
    1.20 +Contents
    1.21 +--------
    1.22 +
    1.23 +COPYING, LICENSE
    1.24 +
    1.25 +  Copying, distribution and modification conditions and terms.
    1.26 +
    1.27 +INSTALL
    1.28 +
    1.29 +  For general building and installation instructions, see the file
    1.30 +
    1.31 +lemon/
    1.32 +
    1.33 +  Source code of LEMON itself.
    1.34 +
    1.35 +doc/
    1.36 +
    1.37 +  Documentation of LEMON. The starting page is doc/html/index/html.
    1.38 +  The documentation installs into the directory
    1.39 +
    1.40 +    /usr/local/share/doc/lemon/html
    1.41 +
    1.42 +  or -- if you use different prefix -- into
    1.43 +
    1.44 +    ${prefix}/share/doc/lemon/html
    1.45 +
    1.46 +  (see also INSTALL).
    1.47 +
    1.48 +demo/
    1.49 +
    1.50 +  Some demonstration programs to make you easier to getting familiar
    1.51 +  with LEMON. Use --enable-demo configure option to also compile these
    1.52 +  codes (see also INSTALL).
    1.53 +
    1.54 +test/
    1.55 +
    1.56 +  Contains programs to check the integrity and correctness of
    1.57 +  LEMON. The command 'make check' performs these tests.
    1.58 +
    1.59 +benchmark/
    1.60 +  
    1.61 +  Contains programs measuring the performance of LEMON. Use
    1.62 +  --enable-benchmark configure option to also compile these codes (see
    1.63 +  also INSTALL).