Changeset 2139:582c8c28aa01 in lemon-0.x for README

Timestamp:

07/14/06 12:51:14 (18 years ago)

Author:

Alpar Juttner

Branch:

default

Phase:

public

Convert:

svn:c9d7d8f5-90d6-0310-b91f-818b3a526b0e/lemon/trunk@2853

Message:

Some updates and restructuring

File:

• README (modified) (1 diff)

README

@@ -1 @@
-LEMON
+------------------------------------------------------------------
+LEMON - a Library of Efficient Models and Optimization in Networks
+------------------------------------------------------------------
 
-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
+intended to become an open source library in order to involve people
+all around the world in its development.
 
-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 intended to become an
-open source library in order to involve people all around
-the world in its development.
+--------
+Contents
+--------
 
-The subdirectories 'autopackage', 'build-aux' and 'm4' are
-needed by installation. In subdirectory 'benchmark'
-programs can be found that observe the performance of LEMON.
-Subdirectory 'demo' contains some demonstration programs to
-make you easier to getting familiar with LEMON. Documentation
-of LEMON can be found in subdirectory 'doc'. Source code of
-LEMON is in subdirectory 'lemon'. Some useful scripts related
-to the usage of LEMON can be found in subdirectory 'scripts'.
-In subdirectory 'test' you can find some programs, proofing
-you the correctness of some implementations.
+COPYING, LICENSE
 
-See file COPYING for copying, distribution and modification
-conditions and terms.
+  Copying, distribution and modification conditions and terms.
 
-For general building and installation instructions, see the
-file INSTALL.
+INSTALL
 
-Version number of the package is the highest one written in
-file NEWS.
+  For general building and installation instructions, see the file
+
+lemon/
+
+  Source code of LEMON itself.
+
+doc/
+
+  Documentation of LEMON. The staring page is doc/html/index/html.
+  The documentation will be installed 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).