Document new options and tidy up a few other parts of documentation
[cteddy.git] / README
blob98738785695f82caa5d0c6d9d4701e9ac3a85417
1 cteddy
2 ======
4 From the man page, adapted from that of the original Xteddy:
6         cteddy is a cuddly teddy bear for your composited X Window System
7         desktop.  Normally, cteddy just sits around doing nothing. After all,
8         that's what teddy bears are for.  Look at him, talk to him, place heavy
9         windows on top of him, zap him around until he becomes dizzy, do what
10         you like; he will always be your true (albeit virtual) friend.
12 The original Xteddy was written by Stefan Gustavson.  Its image support was
13 later expanded by Andreas Tille, through the usage of Imlib of Xteddy 2.
14 Both the basic version 1.1 and updated version 2.0.1 can be found at:
16         http://staffwww.itn.liu.se/~stegu/xteddy/
18 Whilst undeniably cute, both of these versions have a fatal flaw when used
19 in conjunction with modern compositing window managers such as Compiz.
20 Although the displayed windows are shaped, they are plain white, instead of
21 fur-coloured!
22   Rather than try and fix this with an Xteddy 3, I decided instead to write
23 my own version from scratch, using libraries I knew could do the job; namely,
24 GTK+ and Cairo.  This is the result.
25   cteddy is intended as a drop-in replacement, minus the "-wm" option (cteddy
26 does not bypass the window manager, it simply asks it for an undecorated
27 window) and the "-geometry" and "-display" options (currently left
28 unimplemented).  It also contains a new toy (cdoggy), and a selection of
29 additional options, implemented for their utility and/or as a learning
30 exercise.
32 Philip Allison <sane@not.co.uk>