# HG changeset patch
# User Akos Ladanyi <ladanyi@tmit.bme.hu>
# Date 1217416068 -3600
# Node ID 1686b3f5914118554eda007c3cf3ebba0819b030
# Parent da1d220b176b415065fa9db8ce282d972b465b2b
Update README file.
diff --git a/README b/README
|
a
|
b
|
|
| 1 | | ------------------------------------------------------------------ |
| 2 | | LEMON - a Library of Efficient Models and Optimization in Networks |
| 3 | | ------------------------------------------------------------------ |
| | 1 | LEMON |
| | 2 | ===== |
| 4 | 3 | |
| 5 | | LEMON is the abbreviation of Library of Efficient Models and |
| 6 | | Optimization in Networks. It is an open source library written in |
| 7 | | C++. It provides a set of easy-to-use implementation of common data |
| 8 | | structures and algorithms in the area of optimization and helps |
| 9 | | implementing new ones. It is an especially suitable tool to solve the |
| 10 | | design and optimization problems of telecommunications networks. To |
| 11 | | achieve wide usability, a fundamental design requirement is the |
| 12 | | genericity of interface of data structures and algorithms. LEMON is an |
| 13 | | open source library end invites people all around the world in its |
| 14 | | development. |
| | 4 | LEMON stands for Library of Efficient Models and Optimization in Networks. |
| | 5 | It is an open source library written in C++. It provides easy-to-use |
| | 6 | implementations of common data structures and algorithms in the area of |
| | 7 | optimization and helps implementing new ones. It is especially suitable for |
| | 8 | solving design and optimization problems of telecommunication networks. To |
| | 9 | achieve wide usability its data structures and algorithms provide generic |
| | 10 | interfaces. |
| 15 | 11 | |
| 16 | | -------- |
| | 12 | LEMON is also an open source project therefore everybody is welcome to |
| | 13 | participate in the further development of the library. |
| | 14 | |
| | 15 | |
| 17 | 16 | Contents |
| 18 | | -------- |
| | 17 | ======== |
| 19 | 18 | |
| 20 | | COPYING, LICENSE |
| | 19 | LICENSE |
| 21 | 20 | |
| 22 | | |
| | 21 | Copying, distribution and modification conditions and terms. |
| 23 | 22 | |
| 24 | 23 | INSTALL |
| 25 | 24 | |
| 26 | | For general building and installation instructions, see the file. |
| | 25 | General building and installation instructions. |
| 27 | 26 | |
| 28 | 27 | lemon/ |
| 29 | 28 | |
| 30 | | Source code of LEMON itself. |
| | 29 | Source code of LEMON library. |
| 31 | 30 | |
| 32 | 31 | doc/ |
| 33 | 32 | |
| 34 | | Documentation of LEMON. The starting page is doc/html/index.html. |
| 35 | | The documentation installs into the directory |
| 36 | | |
| 37 | | /usr/local/share/doc/lemon/html |
| 38 | | |
| 39 | | or -- if you use different prefix -- into |
| 40 | | |
| 41 | | ${prefix}/share/doc/lemon/html |
| 42 | | |
| 43 | | (see also INSTALL). |
| | 33 | Documentation of LEMON. The starting page is doc/html/index.html. |
| 44 | 34 | |
| 45 | 35 | demo/ |
| 46 | 36 | |
| 47 | | Some demonstration programs to make you easier to get familiar with |
| 48 | | LEMON. Use --enable-demo configure option to also compile these codes |
| 49 | | (see also INSTALL). |
| | 37 | Some example programs to make you easier to get familiar with LEMON. |
| 50 | 38 | |
| 51 | 39 | test/ |
| 52 | 40 | |
| 53 | | Contains programs to check the integrity and correctness of |
| 54 | | LEMON. The command 'make check' performs these tests. |
| | 41 | Contains programs to check the integrity and correctness of LEMON. |
| 55 | 42 | |
| 56 | 43 | benchmark/ |
| 57 | 44 | |
| 58 | | Contains programs measuring the performance of LEMON. Use |
| 59 | | --enable-benchmark configure option to also compile these codes (see |
| 60 | | also INSTALL). |
| | 45 | Contains programs for measuring the performance of algorithms. |
| | 46 | |
| | 47 | tools/ |
| | 48 | |
| | 49 | Various utilities related to LEMON. |
