aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--[l---------]README.md119
1 files changed, 118 insertions, 1 deletions
diff --git a/README.md b/README.md
index 487a367..fac492d 120000..100644
--- a/README.md
+++ b/README.md
@@ -1 +1,118 @@
-./src/README \ No newline at end of file
+dminiwm
+=======
+
+### ~ 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]
+
+ [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.
+
+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:*
+
+ --------------
+ | | W |
+ | |___|
+ | Master | |
+ | |___|
+ | | |
+ --------------
+
+---
+
+*Horizontal tiling mode:*
+
+ -------------
+ | |
+ | Master |
+ |-----------|
+ | W | | |
+ -------------
+
+---
+
+ *Grid tiling mode:*
+
+ -------------
+ | | W |
+ | | |
+ |------|----|
+ | | |
+ -------------
+
+---
+
+ *Fullscreen mode* (you'll know when you see it)
+
+ -------------
+ | |
+ | |
+ | |
+ | |
+ -------------
+
+---
+
+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.
+
+
+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
+
+
+Installation
+------------
+
+You need Xlib, then,
+copy the `config.h.deh` file as `config.h` and edit to suit your needs.
+Build and install the project.
+
+ $ cp config.h.def config.h
+ $ $EDITOR config.h # optional
+
+ $ make
+ # make install
+ $ make clean
+
+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
+