docs/src/index.md

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

mercurial