2018-12-31 14:25:17 +00:00
|
|
|
kiwmi
|
|
|
|
|
=====
|
|
|
|
|
|
2019-02-14 16:38:41 +00:00
|
|
|
A client controlled Wayland compositor.
|
2018-12-31 14:25:17 +00:00
|
|
|
|
|
|
|
|
Configuration
|
|
|
|
|
-------------
|
|
|
|
|
|
2019-03-07 22:35:40 +00:00
|
|
|
Configuration languages are confusing. They are neither flexible nor easy to use. Moreover, they add significant complexity to the program itself.
|
|
|
|
|
kiwmi listens to a socket and offers a basic client, kiwmic, to communicate with kiwmi, similarly to how bspwm works.
|
2018-12-31 14:25:17 +00:00
|
|
|
|
|
|
|
|
This allows the user to write the configuration in any langauge, e.g. as a bash script, which allows for high flexibility.
|
|
|
|
|
|
2019-03-07 22:35:40 +00:00
|
|
|
kiwmi handles almost nothing on it's own, and instead it emits events, to which the client can subscribe and react accordingly.
|
|
|
|
|
This allows for 100% flexibility and customizability, while requiring little overhead effort.
|
|
|
|
|
New user configurations will be linked as they are created, to help new users get started.
|
2019-02-14 16:38:41 +00:00
|
|
|
|
2019-03-07 22:35:40 +00:00
|
|
|
kiwmi will end up being configured by a monolithic frontend, or collection of small scripts.
|
|
|
|
|
A small (probably) Python library may be created to aid creating a monolithic frontend.
|
2018-12-31 14:25:17 +00:00
|
|
|
|
2019-03-10 22:04:42 +00:00
|
|
|
*WARNING*: Right now you shouldn't run kiwmi from a TTY, as you won't be able to exit it.
|
|
|
|
|
|
2018-12-31 14:25:17 +00:00
|
|
|
Dependencies
|
|
|
|
|
------------
|
|
|
|
|
|
2019-02-14 16:38:41 +00:00
|
|
|
- https://github.com/swaywm/wlroots[wlroots]
|
|
|
|
|
- meson (build)
|
|
|
|
|
- ninja (build)
|
|
|
|
|
- git (build, optional, to fetch the version)
|
2018-12-31 14:25:17 +00:00
|
|
|
|
|
|
|
|
Building
|
|
|
|
|
--------
|
|
|
|
|
|
2019-03-07 22:35:40 +00:00
|
|
|
Make sure all dependencies are installed.
|
|
|
|
|
|
|
|
|
|
Run:
|
2019-02-14 16:38:41 +00:00
|
|
|
|
|
|
|
|
----
|
|
|
|
|
$ meson build
|
|
|
|
|
$ ninja -C build
|
|
|
|
|
----
|
|
|
|
|
|
2019-03-07 22:35:40 +00:00
|
|
|
Install with:
|
2019-02-14 16:38:41 +00:00
|
|
|
|
2018-12-31 14:25:17 +00:00
|
|
|
----
|
2019-02-14 16:38:41 +00:00
|
|
|
# ninja -C build install
|
2018-12-31 14:25:17 +00:00
|
|
|
----
|
|
|
|
|
|
|
|
|
|
Contribution
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
You want to contribute? Great!
|
|
|
|
|
|
|
|
|
|
Future requests, bug reports and PRs are always welcome.
|
|
|
|
|
Note that pull requests without a valid issue are ignored to decrease the amount of duplicate work.
|
2019-02-20 10:58:02 +00:00
|
|
|
Also read link:CONTRIBUTING.adoc[CONTRIBUTING.adoc].
|
2018-12-31 14:25:17 +00:00
|
|
|
|
|
|
|
|
If anything is unclear, feel free to contact me.
|
|
|
|
|
|
|
|
|
|
If you don't program but want to contribute to kiwmi, spread the word about kiwmi and star the repo.
|
