Added very primitive documentation files.

[vblib.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..7273c4a
--- /dev/null
+++ b/README
@@ -0,0 +1,20 @@
+VarBuf Library, version 1.0.0
+-----------------------------
+
+  Homepage of VarBuf Library: http://atrey.karlin.mff.cuni.cz/~short/sw/#vblib
+
+       This library is still not much cleaned up. It was originally developed for
+Czech companies Geoinvest (http://www.geoinvest.cz/) / Princip
+(http://www.princip.cz/) which were so kind to let me release it.
+
+       This library enables application to easily do input/output functions (like
+read/write, printf etc.) with memory streams while using performance effective
+functions. Simple buffer copying/moving would be possible but it would case a
+major performance hit if not using algorithms implemented in this library.
+
+  Please *REALLY* let me <short@ucw.cz> now if you are at least somehow
+interested in this library, proper documentation still not written etc.
+
+
+Happy using VarBuf Library,
+Jan Kratochvil