kitchen/kiwmi
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
A fully programmable Wayland Compositor
187 commits 1 branch 0 tags 1.4 MiB
C 97.4%
Meson 2.6%
Find a file
Charlotte Meyer a736f0281b Add tostring to IPC results
2020-08-27 14:26:58 +00:00
include Fix lua5.1 compat (for luajit) 2020-07-30 21:34:34 +00:00
kiwmi Add tostring to IPC results 2020-08-27 14:26:58 +00:00
kiwmic Add kiwmic IPC 2020-01-03 18:40:11 +00:00
protocols Add enum field to kiwmi_command::done 2020-01-15 20:31:53 +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
lua_docs.md Fix misspelling (#23) 2020-08-18 13:59:07 +00:00
meson.build Allow user to change their lua version 2020-05-11 15:11:23 +00:00
meson_options.txt Allow user to change their lua version 2020-05-11 15:11:23 +00:00
README.md Allow user to change their lua version 2020-05-11 15:11:23 +00:00

README.md

kiwmi

A fully programmable Wayland Compositor

Stars GitHub issues GitHub contributors

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

If you plan to use luajit instead, use the following commands instead.

$ meson -Dlua-pkg=luajit 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.