From: Michal Vaner <vorner@ucw.cz>
Date: Thu, 30 Oct 2008 13:01:19 +0000 (+0100)
Subject: ucw docs: Intro in index.html
X-Git-Tag: holmes-import~230
X-Git-Url: http://mj.ucw.cz/gitweb/?a=commitdiff_plain;h=0d93a42f5957e5ee61a292d21fa2098db779d0a8;p=libucw.git

ucw docs: Intro in index.html
---

diff --git a/ucw/doc/index.txt b/ucw/doc/index.txt
index 3f00230e..3b51ec17 100644
--- a/ucw/doc/index.txt
+++ b/ucw/doc/index.txt
@@ -1,9 +1,16 @@
 UCW libraries
 =============
 
-////
-TODO: Some general description, what the libraries are, why, etc...
-////
+The UCW libraries aim to provide some general purpose tools for C
+programming language. It contains faster implementations of some
+algorithms found in libc (for example, sorting), few commonly used not
+available in libc (sha1 hash), several generic data structures (hash
+tables, binomial heap) and some less common tools (memory pools).
+
+It is probable you may save yourself some time by using this library.
+
+Please note this documentation is not yet complete. There are lot of
+modules not yet described, look into the source code.
 
 You can see list of <<def_index:,definitions>>.