]> mj.ucw.cz Git - libucw.git/commitdiff
ucw docs: Intro in index.html
authorMichal Vaner <vorner@ucw.cz>
Thu, 30 Oct 2008 13:01:19 +0000 (14:01 +0100)
committerMichal Vaner <vorner@ucw.cz>
Thu, 30 Oct 2008 13:01:19 +0000 (14:01 +0100)
ucw/doc/index.txt

index 3f00230ef139bf35f7df5e7f12646670aed1ed65..3b51ec17d9e58299fc01e180ba45710f6c6541c4 100644 (file)
@@ -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>>.