]> code.delx.au - spectrwm/commitdiff
start reworking wiki/front page
authorMarco Peereboom <marco@peereboom.us>
Mon, 2 May 2016 21:21:11 +0000 (16:21 -0500)
committerMarco Peereboom <marco@peereboom.us>
Mon, 2 May 2016 21:21:11 +0000 (16:21 -0500)
README.md

index 00fc96e5f3f5153a2351cb7db629e923f8719835..2bc069611443fb87cb6c2757398301151c6dd731 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,11 +1,57 @@
 spectrwm
 ========
 
-spectrwm is a small dynamic tiling window manager for X11. It tries to
-stay out of the way so that valuable screen real estate can be used for
-much more important stuff. It has sane defaults and does not require one
-to learn a language to do any configuration. It was written by hackers
-for hackers and it strives to be small, compact and fast.
+spectrwm is a small dynamic tiling and reparenting window manager for X11. It
+tries to stay out of the way so that valuable screen real estate can be used
+for much more important stuff. It has sane defaults and does not require one to
+learn a language to do any configuration. It is written by hackers for hackers
+and it strives to be small, compact and fast.
+
+It was largely inspired by [http://xmonad.org xmonad] and
+[http://dwm.suckless.org dwm]. Both are fine products but suffer from things
+like: crazy-unportable-language-syndrome, silly defaults, asymmetrical window
+layout, "how hard can it be?" and good old NIH.  Nevertheless
+[http://dwm.suckless.org dwm] was a phenomenal resource and many good ideas and
+code was borrowed from it. On the other hand [http://xmonad.org xmonad] has
+great defaults, key bindings and xinerama support but is crippled by not being
+written in C.
+
+spectrwm is a beautiful pearl! For it too, was created by grinding irritation.
+Nothing is a bigger waste of time than moving windows around until they are the
+right size-ish or having just about any relevant key combination being eaten
+for some task one never needs. The path of agony is too long to quote and in
+classical [http://www.openbsd.org OpenBSD] fashion (put up, or hack up) a brand
+new window manager was whooped up to serve no other purpose than to obey its
+masters. It is released under the ISC license. Patches can be accepted provided
+they are ISC licensed as well.
+
+You can and come chat with us on IRC. We use https://www.oftc.net/ channel #spectrwm.
+
+## Major features
+* Dynamic RandR support (multi-head)
+* Navigation anywhere on all screens with either the keyboard or mouse
+* Customizable status bar
+* Human readable configuration file
+* Restartable without losing state
+* Quick launch menu
+* Many screen layouts possible with a few simple key strokes
+* Windows can be added or removed from master area
+* Windows can be moved to any workspace or within a region
+* Resizable master area
+* Move/resize floating windows
+* Drag-to-float
+* Extended Window Manager Hints (EWMH) Support
+* Configureable tiling
+* Adjustable tile gap allows for a true one pixel border.
+* Customizable colors and border width.
+* User definable regions
+* User definable modkey & key bindings
+* User definable quirk bindings
+* User definable key bindings to launch applications
+* Multi OS support (*BSD, Linux, OSX, Windows/cygwin) 
+* Reparenting window manager
+
+[https://github.com/conformal/spectrwm/wiki/Screenshots Mandatory screenshots can be found here.]
 
 ## License