]> code.delx.au - spectrwm/blobdiff - README.md
right link and add feedback heading
[spectrwm] / README.md
index 2bc069611443fb87cb6c2757398301151c6dd731..d1bc4f55e16cb305ef45b2d6f595da7b892a70ee 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,25 +7,27 @@ 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
+It was largely inspired by [xmonad](http://xmonad.org xmonad) and
+[dwm](http://dwm.suckless.org). 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.
+[dwm](http://dwm.suckless.org) was a phenomenal resource and many good ideas
+and code was borrowed from it. On the other hand [xmonad](http://xmonad.org)
+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.
+classical [OpenBSD](http://www.openbsd.org) 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.
+## Feedback and questions
+You can and come chat with us on IRC. We use [OFTC](https://www.oftc.net)
+channel #spectrwm.
 
 ## Major features
 * Dynamic RandR support (multi-head)
@@ -51,8 +53,25 @@ You can and come chat with us on IRC. We use https://www.oftc.net/ channel #spec
 * Multi OS support (*BSD, Linux, OSX, Windows/cygwin) 
 * Reparenting window manager
 
-[https://github.com/conformal/spectrwm/wiki/Screenshots Mandatory screenshots can be found here.]
+## Documentation
+[Click here for current man page](https://htmlpreview.github.io/?https://github.com/conformal/spectrwm/blob/master/spectrwm.html)
 
 ## License
 
 spectrwm is ISC licensed unless otherwise specified in individual files.
+
+## Screenshots
+![Vertical stack]
+(https://github.com/conformal/spectrwm/wiki/Scrotwm1.png)
+
+![Horizontal stack]
+(https://github.com/conformal/spectrwm/wiki/Scrotwm2.png)
+
+![Horizontal stack]
+(https://github.com/conformal/spectrwm/wiki/Scrotwm3.png)
+
+![Vertical stack with floater and extra window in master area]
+(https://github.com/conformal/spectrwm/wiki/Scrotwm4.png)
+
+![mplayer, resized and moved]
+(https://github.com/conformal/spectrwm/wiki/Scrotwm5.png)