kiwmi/README.txt

46 lines
1.1 KiB
Text
Raw Normal View History

2019-10-16 16:21:44 +00:00
kiwmi
=====
2019-12-22 02:20:08 +00:00
kiwmi is a Wayland compositor that is programmed by the user.
This means that the sky is the limit:
You can implement any tiling or floating logic you want; even stuff like modal window management becomes easy.
2019-10-16 16:21:44 +00:00
2019-12-22 02:20:08 +00:00
This means there is a steep entrance barrier, but in the future there will be base configurations to start with.
2019-10-16 16:21:44 +00:00
2019-12-22 02:20:08 +00:00
NOTE: This whole project is a work in project, and not usable yet.
2019-10-16 16:21:44 +00:00
2019-12-22 02:20:08 +00:00
Installation
2019-10-16 16:21:44 +00:00
------------
Make sure all dependencies are installed.
Run:
2019-12-22 02:20:08 +00:00
$ meson build
$ ninja -C build
2019-10-16 16:21:44 +00:00
Install with:
2019-12-22 02:20:08 +00:00
# ninja -C build install
Dependencies
------------
- wlroots (https://github.com/swaywm/wlroots)
- meson (build)
- ninja (build)
- git (build, optional, to fetch the version)
2019-10-16 16:21:44 +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-12-22 02:20:08 +00:00
Also read CONTRIBUTING.txt.
2019-10-16 16:21:44 +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.