summaryrefslogtreecommitdiff
path: root/lemon/README
diff options
context:
space:
mode:
Diffstat (limited to 'lemon/README')
-rw-r--r--lemon/README50
1 files changed, 50 insertions, 0 deletions
diff --git a/lemon/README b/lemon/README
new file mode 100644
index 0000000..52a768c
--- /dev/null
+++ b/lemon/README
@@ -0,0 +1,50 @@
+=====================================================================
+LEMON - a Library for Efficient Modeling and Optimization in Networks
+=====================================================================
+
+LEMON is an open source library written in C++. It provides
+easy-to-use implementations of common data structures and algorithms
+in the area of optimization and helps implementing new ones. The main
+focus is on graphs and graph algorithms, thus it is especially
+suitable for solving design and optimization problems of
+telecommunication networks. To achieve wide usability its data
+structures and algorithms provide generic interfaces.
+
+Contents
+========
+
+LICENSE
+
+ Copying, distribution and modification conditions and terms.
+
+NEWS
+
+ News and version history.
+
+INSTALL
+
+ General building and installation instructions.
+
+lemon/
+
+ Source code of LEMON library.
+
+doc/
+
+ Documentation of LEMON. The starting page is doc/html/index.html.
+
+demo/
+
+ Some example programs to make you easier to get familiar with LEMON.
+
+scripts/
+
+ Scripts that make it easier to develop LEMON.
+
+test/
+
+ Programs to check the integrity and correctness of LEMON.
+
+tools/
+
+ Various utilities related to LEMON.