Added very primitive documentation files.
[vblib.git] / README
1 VarBuf Library, version 1.0.0
2 -----------------------------
3
4   Homepage of VarBuf Library: http://atrey.karlin.mff.cuni.cz/~short/sw/#vblib
5
6         This library is still not much cleaned up. It was originally developed for
7 Czech companies Geoinvest (http://www.geoinvest.cz/) / Princip
8 (http://www.princip.cz/) which were so kind to let me release it.
9
10         This library enables application to easily do input/output functions (like
11 read/write, printf etc.) with memory streams while using performance effective
12 functions. Simple buffer copying/moving would be possible but it would case a
13 major performance hit if not using algorithms implemented in this library.
14
15   Please *REALLY* let me <short@ucw.cz> now if you are at least somehow
16 interested in this library, proper documentation still not written etc.
17
18
19 Happy using VarBuf Library,
20 Jan Kratochvil