more convenient and flexible implementation of dptr;

[web/konrad/chester.git] / README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..129ef7f
--- /dev/null
+++ b/README
@@ -0,0 +1,24 @@
+README for Chester
+===================
+
+Chester is an implementation of the Cheshire Cat idiom - also known as
+d-pointer, PImpl (Pointer IMPLementation), or opaqua data pointer.
+It hides the data of a class behind a "d" pointer.
+
+This implementation takes away much of the bookkeeping work, like allocating
+and de-allocating the pointer.
+
+It does not need to be built, since it is composed of macros, but you can 
+generate documentation by calling doxygen inside this directory.
+
+All the files in this directory are copyrighted under a permissive license:
+ Copying and distribution of this file, with or without modification,
+ are permitted in any medium without royalty provided the copyright
+ notice and this notice are preserved.  This file is offered as-is,
+ without any warranty.
+
+So, you are free to use this implementation in any project under any kind of
+license as long as you do not remove my copyright notice.
+
+Although I do not require it, I would appreciate feedback on problems, bugs,
+and the occasional code improvement - if you feel like it...