kiwmi/README.adoc

48 lines
2 KiB
Text
Raw Normal View History

2018-10-02 23:29:47 +02:00
kiwmi
=====
2018-09-27 16:42:20 +02:00
A fully manual tiling window manager for the X window system.
Concepts
--------
2018-11-04 00:05:30 +05:30
Most *manual* window managers aren't *truly* manual. They behave like a dynamic one sometimes. However, kiwmi is fully manual. It doesn't become dynamic all of a sudden.
2018-09-27 16:42:20 +02:00
2018-11-04 00:05:30 +05:30
When a window is spawned without allocating space, it's put in an invisible queue. Then you allocate space for the window; when the window is pulled from the queue, it goes into the aforementioned space. This solves the classic problem with regular window managers, where the window with a longer start time will spawn in the current tag (workspace) instead of the one in which it was opened in.
2018-09-27 16:42:20 +02:00
2018-11-04 00:05:30 +05:30
In kiwmi, empty spaces available for windows behave like a normal window does. You can resize and move around them. Ergo, you don't need to re-learn how a tiling window manager behaves and works.
2018-09-27 16:42:20 +02:00
Configuration
-------------
2018-11-04 00:05:30 +05:30
Configuration languages are confusing. They are neither flexible nor easy to use. Moreover, it adds a lot of complexity to the program itself.
`kiwmi` listens to a socket and offers a basic client, `seed`, to communicate with kiwmi. Much like how `bspwm` works.
2018-09-27 16:42:20 +02:00
2018-11-04 00:05:30 +05:30
This allows the user to write the configuration in any language, while also removing the need to have a custom hotkey manager since you can use external tools like https://github.com/baskerville/sxhkd[sxhkd] instead.
2018-09-27 16:42:20 +02:00
2018-10-26 22:34:35 +02:00
Dependencies
------------
2018-11-04 00:05:30 +05:30
* `libxcb`
* `pkgconfig` (make)
2018-10-26 22:34:35 +02:00
2018-09-28 18:06:34 +02:00
Building
--------
2018-11-04 00:05:30 +05:30
For the most part, configuration is done in link:config.mk[config.mk].
2018-09-28 18:06:34 +02:00
2018-11-04 00:05:30 +05:30
. Make sure to have the dependencies installed.
2018-09-28 18:06:34 +02:00
. `make`
. `sudo make install`
2018-09-27 16:42:20 +02:00
Contribution
------------
2018-09-28 17:46:23 +02:00
You want to contribute? Great!
2018-11-04 00:05:30 +05:30
Future requests, bug reports and PRs are always welcome. Make sure you read the link:CONTRIBUTING.adoc[CONTRIBUTING.adoc]. Note that pull requests without a valid issue are ignored to decrease the amount of duplicate work.
If anything is unclear, feel free to contact me.
2018-09-28 17:46:23 +02:00
2018-11-04 00:05:30 +05:30
If you don't program but want to contribute to kiwmi, spread the world about kiwmi and star the repo.