aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md94
1 files changed, 60 insertions, 34 deletions
diff --git a/README.md b/README.md
index 1580a73..c3e1d90 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,32 @@
-##dminiwm
-### it's minimal and dynamic
+dminiwm
+=======
-I started this from catwm 31/12/10 ( https://bbs.archlinux.org/viewtopic.php?id=100215&p=1 )
- See dminiwm.c or config.h for thanks and licensing.
-Screenshots and ramblings/updates at https://bbs.archlinux.org/viewtopic.php?id=126463
+### ~ it's minimal and dynamic
+I started this from [catwm][cwm] 31/12/10 ([ArchLinux forums][cwmf])
+Credits and licensing included in `dminiwm.c` and/or `config.h.def`.
+For screenshots and ramblings/updates check [the topic on ArchLinux forums][dmnf]
-###Summary
--------
+ [cwm]: https://github.com/pyknite/catwm
+ [cwmf]: https://bbs.archlinux.org/viewtopic.php?id=100215&p=1
+ [dmnf]: https://bbs.archlinux.org/viewtopic.php?id=126463
+Summary
+-------
**dminiwm** is a very minimal and lightweight dynamic tiling window manager.
- I will try to stay under 1000 SLOC.
- Currently under 900 lines with the config file included.
-
+I will try to stay under 1000 SLOC.
+Currently under 900 lines with the config file included.
-###Modes
+Modes
-----
It allows the "normal" method of tiling window managers(with the new window as the master)
and with the new window opened at the bottom of the stack(like dwm's attach_aside)
- *There's vertical tiling mode:*
+---
+
+*There's vertical tiling mode:*
--------------
| | W |
@@ -31,7 +36,9 @@ It allows the "normal" method of tiling window managers(with the new window as t
| | |
--------------
- *Horizontal tiling mode:*
+---
+
+*Horizontal tiling mode:*
-------------
| |
@@ -39,7 +46,9 @@ It allows the "normal" method of tiling window managers(with the new window as t
|-----------|
| W | | |
-------------
-
+
+---
+
*Grid tiling mode:*
-------------
@@ -49,54 +58,71 @@ It allows the "normal" method of tiling window managers(with the new window as t
| | |
-------------
- *Fullscreen mode*(which you'll know when you see it)
+---
+
+ *Fullscreen mode* (you'll know when you see it)
+
+ -------------
+ | |
+ | |
+ | |
+ | |
+ -------------
+
+---
+
+All accessible with keyboard shortcuts defined in the config.h file.
- All accessible with keyboard shortcuts defined in the config.h file.
-
* The window W at the top of the stack can be resized on a per desktop basis.
* Changing a tiling mode or window size on one desktop doesn't affect the other desktops.
-###Recent Changes
+Recent Changes
--------------
15/10/11
Added having applications open on specified desktop
-
-###Status
+Status
------
There are more options in the config file than the original catwm.
- * Fixed the window manager crashing on a bad window error.
- * Fixed the keyboard shortcuts not working if numlock was on.
- * Added some functions.
- * Added an option to focus the window the mouse just moved to.
- * Fixed a window being destroyed on another desktop creating ghost windows.
- * Added ability to resize the window on the top of the stack
- * Added having applications open on specified desktop
+ * Fixed the window manager crashing on a bad window error.
+ * Fixed the keyboard shortcuts not working if numlock was on.
+ * Added some functions.
+ * Added an option to focus the window the mouse just moved to.
+ * Fixed a window being destroyed on another desktop creating ghost windows.
+ * Added ability to resize the window on the top of the stack
+ * Added having applications open on specified desktop
-###Installation
+Installation
------------
-Need Xlib, then:
+You need Xlib, then,
+copy the `config.h.deh` file as `config.h` and edit to suit your needs.
+Build and install the project.
- edit the config.h file to suit your needs
+ $ cp config.h.def config.h
+ $ $EDITOR config.h # optional
$ make
# make install
$ make clean
-
-###Bugs
+Bugs
----
-[ * No bugs for the moment ;) (I mean, no importants bugs ;)]
+No bugs for the moment ;) (I mean, no importants bugs)
+
+For any issues report at [the topic on ArchLinux forums][dmnf],
+or [fill an issue][bug] on [GitHub][ghp]
+ [bug]: https://github.com/moetunes/dminimalwm/issues
+ [ghp]: https://github.com/moetunes/dminimalwm
-###Todo
+Todo
----
* when swithching desktops stop the mouse being in an unfocused window changing focus.