summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README34
1 files changed, 21 insertions, 13 deletions
diff --git a/README b/README
index 54537c3..37a20f2 100644
--- a/README
+++ b/README
@@ -1,20 +1,18 @@
--*- text -*-
+# mcwm
-This is a window manager for the X Window System written entirely with
-XCB, the straight X protocol binding to the C language. It doesn't use
-libX11 at all.
+mcwm is minimalist, floating window manager written using XCB, the X
+protocol C binding.
-mcwm is a rather minimalist, floating window manager. The only window
-decoration is a thin border. All functions can be done with the
-keyboard, but moving, resizing, raising and lowering can also be done
-with the mouse.
+The only window decoration is a thin border. All functions can be done
+with the keyboard, but moving, resizing, raising and lowering can also
+be done with the mouse.
If you don't like the default key bindings, border width, et cetera,
-look in the config.h file, change and recompile.
+look in the `config.h` file, change and recompile.
See the manual page for how to use it.
-== Compiling ==
+## Compiling
As distributed mcwm compiles fine under FreeBSD. If you want to
compile mcwm under Debian-derived GNU/Linux systems you will need
@@ -23,12 +21,22 @@ libxcb-keysyms1-dev, libxcb-icccm1-dev, libxcb-randr0-dev.
Other system are likely to have similar requirements.
-== More information & Contact ==
+## Screenshot
+
+![](mcwm-screen-20110308.png)
+
+## Children
+
+mcwm has been forked a few times. It was the beginning of the [2bwm
+window manager](https://github.com/venam/2bwm), for instance.
+
+## More information & Contact
Please see:
- http://hack.org/mc/hacks/mcwm/
+https://hack.org/mc/projects/mcwm
To contact me, write to:
- Michael Cardell Widerkrantz <mc@hack.org>
+Michael Cardell Widerkrantz, mc at the domain hack.org.
+