A fully programmable Wayland Compositor

Find a file

Charlotte Meyer 460ec217dd Add hidden, hide and show to views		2020-01-01 18:10:42 +00:00
include	Add hidden, hide and show to views	2020-01-01 18:10:42 +00:00
kiwmi	Add hidden, hide and show to views	2020-01-01 18:10:42 +00:00
protocols	Add protocols (xdg-shell)	2019-12-10 23:37:43 +00:00
.clang-format	Add ForEachMacros to .clang-format	2019-12-30 21:46:50 -07:00
.gitignore	Basic C comp	2019-02-17 13:19:28 +01:00
CONTRIBUTING.md	Replaced README and CONTRIBUTING files	2019-12-21 21:36:48 -05:00
LICENSE	Initial commit	2018-12-31 15:25:17 +01:00
meson.build	Add protocols (xdg-shell)	2019-12-10 23:37:43 +00:00
meson_options.txt	Updated docs	2019-04-17 17:29:22 +02:00
README.md	Overhaul readme	2019-12-22 16:50:08 +00:00

README.md

kiwmi

A fully programmable Wayland Compositor

Stars

kiwmi is a work-in-progress extensive user-configurable Wayland Compositor. kiwmi specifically does not enforce any logic, allowing for the creation of Lua-scripted behaviors, making arduous tasks such as modal window management become a breeze. New users should be aware of the steep learning curve present, however this will be reduced as the project matures.

Getting Started

The dependencies required are:

wlroots
meson (building)
ninja (building)
git (build, optional)

Building

After cloning/downloading the project and ensuring all dependencies are installed, building is as easy as running

$ meson build
$ ninja -C build

Installing is accomplished with the following command:

# ninja -C build install

Contributing

Contributions are welcomed, especially while the project is in a heavy WIP stage. If you believe you have a valid concern, read the CONTRIBUTING document and please file an issue on the issues page.

For clarifications or suggestions on anything, please don't hesitate to contact me.