diff --git a/README b/README index 1e6963e0b282228d4d9925212337e9ba3c239f5b..22409d0754e7e1ac2d389dbc407d266898bb2998 100644 --- a/README +++ b/README @@ -1,3 +1,86 @@ xfwm4 TODO: Write this file ! + +What it does already : + +- It's based on gtk-2.0 +- It uses pango for font rendering, so it handles plenty of characters +sets and can use aa text if GDK_USE_XFT is set +- It implements both GNOME and NET standards, so you can play with +GNOME, Xfce and KDE all at the same time. +- It looks pretty cool and run fairly fast, at least on the systems I've +tested +- It's stable, I switched both at work and at home and I didn't +encounter a crash for a loooong time. However, don't sue me if you run +it and loose the work that should have been done for yesterday ;-) + +What it doesn't do + +- No task list, no icons. Use either kicker from KDE or panel from GNOME +if you want this. Later, a separate task manager will be added, so it's +not a feature that is missing in xfwm4, it will simply be a separate +application... + +What it doesn't do yet : + +Xinerama, session management. + +To test it : + +1) Make sure you have GTK-2.0 installed on your system (get it from +http://www.gtk.org), including pkg-config, pango, atk, glib-2.0.1 and +gtk-2.0.2 + +2) Retrieve xfwm4's sources +# cvs -d:pserver:anonymous@cvs.xfce.sf.net:/cvsroot/xfce login +# cvs -d:pserver:anonymous@cvs.xfce.sf.net:/cvsroot/xfce co +xfce-devel/xfwm4 + +3) Compile xfwm4 + +cd xfce-devel/xfwm4 +./configure && make && make install-strip + +Note that the install procedure is not optimum yet, so it's safer to let +configure install it in /usr/local + +4) For best results, copy xfce-devel/xfwm4/example.xfwm4rc to +$HOME/.xfwm4rc and example.gtkrc-2.0 to $HOME/.gtkrc-2.0 + +5) edit $HOME/.xfwm4rc and set the options according to your taste. The +file is quite self explanatory, however, one cool feature you can test +is themes. + +theme=/usr/local/share/xfwm4/themes/<theme> + +where <theme> can be : + +agua +coldsteel +cruxish +gtk +kde +next +oroborus +platinum +redmond +redmondxp +slimline +xfce + +You can also choose what buttons are visible and where they are located + +# button_layout : +# O = Option menu +# T = Stick +# H = hide +# S = shade +# M = maximize +# C = close +# | = title + +The default is + +button_layout=O|SHMC +