Update README file.
1.1 --- a/README Wed Jul 30 12:07:29 2008 +0100
1.2 +++ b/README Wed Jul 30 12:07:48 2008 +0100
1.3 @@ -1,60 +1,46 @@
1.4 -------------------------------------------------------------------
1.5 +==================================================================
1.6 LEMON - a Library of Efficient Models and Optimization in Networks
1.7 -------------------------------------------------------------------
1.8 +==================================================================
1.9
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 an
1.18 -open source library end invites people all around the world in its
1.19 -development.
1.20 +LEMON is an open source library written in C++. It provides
1.21 +easy-to-use implementations of common data structures and algorithms
1.22 +in the area of optimization and helps implementing new ones. The main
1.23 +focus is on graphs and graph algorithms, thus it is especially
1.24 +suitable for solving design and optimization problems of
1.25 +telecommunication networks. To achieve wide usability its data
1.26 +structures and algorithms provide generic interfaces.
1.27
1.28 ---------
1.29 Contents
1.30 ---------
1.31 +========
1.32
1.33 -COPYING, LICENSE
1.34 +LICENSE
1.35
1.36 - Copying, distribution and modification conditions and terms.
1.37 + Copying, distribution and modification conditions and terms.
1.38
1.39 INSTALL
1.40
1.41 - For general building and installation instructions, see the file.
1.42 + General building and installation instructions.
1.43
1.44 lemon/
1.45
1.46 - Source code of LEMON itself.
1.47 + Source code of LEMON library.
1.48
1.49 doc/
1.50
1.51 - Documentation of LEMON. The starting page is doc/html/index.html.
1.52 - The documentation installs into the directory
1.53 -
1.54 - /usr/local/share/doc/lemon/html
1.55 -
1.56 - or -- if you use different prefix -- into
1.57 -
1.58 - ${prefix}/share/doc/lemon/html
1.59 -
1.60 - (see also INSTALL).
1.61 + Documentation of LEMON. The starting page is doc/html/index.html.
1.62
1.63 demo/
1.64
1.65 - Some demonstration programs to make you easier to get familiar with
1.66 - LEMON. Use --enable-demo configure option to also compile these codes
1.67 - (see also INSTALL).
1.68 + Some example programs to make you easier to get familiar with LEMON.
1.69
1.70 test/
1.71
1.72 - Contains programs to check the integrity and correctness of
1.73 - LEMON. The command 'make check' performs these tests.
1.74 + Contains programs to check the integrity and correctness of LEMON.
1.75
1.76 benchmark/
1.77
1.78 - Contains programs measuring the performance of LEMON. Use
1.79 - --enable-benchmark configure option to also compile these codes (see
1.80 - also INSTALL).
1.81 + Contains programs for measuring the performance of algorithms.
1.82 +
1.83 +tools/
1.84 +
1.85 + Various utilities related to LEMON.