add ignore pattern for git
[web/konrad/chester.git] / README
1 README for Chester
2 ===================
3
4 Chester is an implementation of the Cheshire Cat idiom - also known as
5 d-pointer, PImpl (Pointer IMPLementation), or opaqua data pointer.
6 It hides the data of a class behind a "d" pointer.
7
8 This implementation takes away much of the bookkeeping work, like allocating
9 and de-allocating the pointer.
10
11 It does not need to be built, since it is composed of macros, but you can 
12 generate documentation by calling doxygen inside this directory.
13
14 All the files in this directory are copyrighted under a permissive license:
15  Copying and distribution of this file, with or without modification,
16  are permitted in any medium without royalty provided the copyright
17  notice and this notice are preserved.  This file is offered as-is,
18  without any warranty.
19
20 So, you are free to use this implementation in any project under any kind of
21 license as long as you do not remove my copyright notice.
22
23 Although I do not require it, I would appreciate feedback on problems, bugs,
24 and the occasional code improvement - if you feel like it...