README.md (2438B)
1 <h1 align="center">kiwmi</h1> 2 <p align="center"><i>A fully programmable Wayland Compositor</i></p> 3 <hr><p align="center"> 4 <img alt="Stars" src="https://img.shields.io/github/stars/buffet/kiwmi.svg?label=Stars&style=flat" /> 5 <a href="https://cirrus-ci.com/github/buffet/kiwmi"><img alt="Build Status" src="https://api.cirrus-ci.com/github/buffet/kiwmi.svg"></a> 6 <a href="https://github.com/buffet/kiwmi/issues"><img alt="GitHub Issues" src="https://img.shields.io/github/issues/buffet/kiwmi.svg"/></a> 7 <a href="https://github.com/buffet/kiwmi/graphs/contributors"><img alt="GitHub Contributors" src="https://img.shields.io/github/contributors/buffet/kiwmi"></a> 8 </p> 9 10 kiwmi is a work-in-progress extensive user-configurable Wayland Compositor. 11 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. 12 New users should be aware of the steep learning curve present, however this will be reduced as the project matures. 13 14 Got any questions or want to discuss something? Join us in [#kiwmi on irc.libera.chat](https://web.libera.chat/gamja/?channels=#kiwmi)! 15 16 17 ## Documentation 18 19 Documentation for the API can be found in [lua_docs.md](lua_docs.md). 20 21 Additionally `kiwmic` can be used to send a single lua string to kiwmi for direct evaluation. 22 23 For example: 24 25 ``` 26 $ kiwmic 'return kiwmi:focused_view():id()' 27 94036737803088.0 28 ``` 29 30 ## Getting Started 31 32 The dependencies required are: 33 34 - [wlroots](https://gitlab.freedesktop.org/wlroots/wlroots) 35 - lua or luajit 36 - pixman 37 - meson (build) 38 - ninja (build) 39 - git (build, optional) 40 41 ### Building 42 43 After cloning/downloading the project and ensuring all dependencies are installed, building is as easy as running 44 45 ``` 46 $ meson build 47 $ ninja -C build 48 ``` 49 50 If you plan to use luajit instead, use the following commands instead. 51 52 ``` 53 $ meson -Dlua-pkg=luajit build 54 $ ninja -C build 55 ``` 56 57 Installing is accomplished with the following command: 58 59 ``` 60 # ninja -C build install 61 ``` 62 63 64 ## Contributing 65 66 Contributions are welcomed, especially while the project is in a heavy WIP stage. 67 If you believe you have a valid concern, read the [CONTRIBUTING](https://github.com/buffet/kiwmi/blob/master/CONTRIBUTING.md) document and please file an issue on the [issues page](https://github.com/buffet/kiwmi/issues/new). 68 69 For clarifications or suggestions on anything, please don't hesitate to contact me.