1.1 --- a/README Fri Jul 14 10:50:05 2006 +0000
1.2 +++ b/README Fri Jul 14 10:51:14 2006 +0000
1.3 @@ -1,36 +1,60 @@
1.4 -LEMON
1.5 +------------------------------------------------------------------
1.6 +LEMON - a Library of Efficient Models and Optimization in Networks
1.7 +------------------------------------------------------------------
1.8
1.9 -Library of Efficient Models and Optimization in Networks
1.10 +LEMON is the abbreviation of Library of Efficient Models and
1.11 +Optimization in Networks. It is an open source library written in
1.12 +C++. It provides a set of easy-to-use implementation of common data
1.13 +structures and algorithms in the area of optimization and helps
1.14 +implementing new ones. It is an especially suitable tool to solve the
1.15 +design and optimization problems of telecommunications networks. To
1.16 +achieve wide usability, a fundamental design requirement is the
1.17 +genericity of interface of data structures and algorithms. Lemon is
1.18 +intended to become an open source library in order to involve people
1.19 +all around the world in its development.
1.20
1.21 -LEMON is the abbreviation of Library of Efficient Models
1.22 -and Optimization in Networks. It is an open source
1.23 -library written in C++. It provides a set of easy-to-use
1.24 -implementation of common data structures and algorithms
1.25 -in the area of optimization and helps implementing new
1.26 -ones. It is an especially suitable tool to solve the
1.27 -design and optimization problems of telecommunications
1.28 -networks. To achieve wide usability, a fundamental design
1.29 -requirement is the genericity of interface of data
1.30 -structures and algorithms. Lemon is intended to become an
1.31 -open source library in order to involve people all around
1.32 -the world in its development.
1.33 +--------
1.34 +Contents
1.35 +--------
1.36
1.37 -The subdirectories 'autopackage', 'build-aux' and 'm4' are
1.38 -needed by installation. In subdirectory 'benchmark'
1.39 -programs can be found that observe the performance of LEMON.
1.40 -Subdirectory 'demo' contains some demonstration programs to
1.41 -make you easier to getting familiar with LEMON. Documentation
1.42 -of LEMON can be found in subdirectory 'doc'. Source code of
1.43 -LEMON is in subdirectory 'lemon'. Some useful scripts related
1.44 -to the usage of LEMON can be found in subdirectory 'scripts'.
1.45 -In subdirectory 'test' you can find some programs, proofing
1.46 -you the correctness of some implementations.
1.47 +COPYING, LICENSE
1.48
1.49 -See file COPYING for copying, distribution and modification
1.50 -conditions and terms.
1.51 + Copying, distribution and modification conditions and terms.
1.52
1.53 -For general building and installation instructions, see the
1.54 -file INSTALL.
1.55 +INSTALL
1.56
1.57 -Version number of the package is the highest one written in
1.58 -file NEWS.
1.59 + For general building and installation instructions, see the file
1.60 +
1.61 +lemon/
1.62 +
1.63 + Source code of LEMON itself.
1.64 +
1.65 +doc/
1.66 +
1.67 + Documentation of LEMON. The staring page is doc/html/index/html.
1.68 + The documentation will be installed into the directory
1.69 +
1.70 + /usr/local/share/doc/lemon/html
1.71 +
1.72 + or -- if you use different prefix -- into
1.73 +
1.74 + ${prefix}/share/doc/lemon/html
1.75 +
1.76 + (see also INSTALL).
1.77 +
1.78 +demo/
1.79 +
1.80 + Some demonstration programs to make you easier to getting familiar
1.81 + with LEMON. Use --enable-demo configure option to also compile these
1.82 + codes (see also INSTALL).
1.83 +
1.84 +test/
1.85 +
1.86 + Contains programs to check the integrity and correctness of
1.87 + LEMON. The command 'make check' performs these tests.
1.88 +
1.89 +benchmark/
1.90 +
1.91 + Contains programs measuring the performance of LEMON. Use
1.92 + --enable-benchmark configure option to also compile these codes (see
1.93 + also INSTALL).