docs/src/index.md

changeset 259
2f5dea574a75
parent 256
2c21b42cf11d
child 264
24f5484bae97
--- a/docs/src/index.md	Sat Oct 28 11:25:27 2017 +0200
+++ b/docs/src/index.md	Sat Oct 28 15:43:51 2017 +0200
@@ -1,2 +1,26 @@
 UAP Common Extensions
 =====================
+
+Welcome to the UAP Common Extensions.
+
+With this library we provide useful data structures and algorithms for common
+programmatic tasks in the C language. By design the features are divided into
+modules to minimize the library footprint. Using the build files you can create
+a static and a shared lib containing all modules, but you may also use the UCX
+sources in your project and compile specific modules by yourself to further
+minimize the footprint.
+
+If you want to use this library, you can [download and install](/install.html)
+the recent version.
+The source code is also available as Mercurial repository [at our site][1] and
+on [Source Forge][2].
+
+[1]: https://develop.uap-core.de/hg/ucx/
+[2]: https://sourceforge.net/p/ucx/code/
+
+### Authors
+
+Mike Becker [<universe@uap-core.de>](mailto:universe@uap-core.de)
+
+Olaf Wintermann
+[<olaf.wintermann@gmail.com>](mailto:olaf.wintermann@gmail.com)

mercurial