kitchen/kiwmi
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Change readme

Browse source
This commit is contained in:
buffet 2019-10-16 18:21:44 +02:00
parent ffd4a89db0
commit 084b2bca84
2 changed files with 54 additions and 58 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

58
README.adoc
View file

@ -1,58 +0,0 @@
kiwmi
=====
A client controlled Wayland compositor.
Configuration
-------------
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.
This allows the user to write the configuration in any langauge, e.g. as a bash script, which allows for high flexibility.
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.
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.
Dependencies
------------
- https://github.com/swaywm/wlroots[wlroots]
- meson (build)
- ninja (build)
- git (build, optional, to fetch the version)
Building
--------
Make sure all dependencies are installed.
Run:
----
$ meson build
$ ninja -C build
----
Install with:
----
# ninja -C build install
----
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.
Also read link:CONTRIBUTING.adoc[CONTRIBUTING.adoc].
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.

54
README.txt Normal file
View file

@ -0,0 +1,54 @@
kiwmi
=====
A fully programmable Waylnd Compositor.
NOTE: This whole project is a work in project, and is far from working.
Concepts
--------
kiwmi is cool and all, because it doesn't enforce any logic itself.
This means that the user can easily (via some Lua scripting) create their own behaiors, and can do anything they wish!
Of course this means that there is a steep curve to get into it, but for some people it might be worth it.
In the future there might be a base to base your stuff on, but at the moment this doesn't even work.
Dependencies
------------
- https://github.com/swaywm/wlroots[wlroots]
- meson (build)
- ninja (build)
- git (build, optional, to fetch the version)
Building
--------
Make sure all dependencies are installed.
Run:
----
$ meson build
$ ninja -C build
----
Install with:
----
# ninja -C build install
----
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.
Also read link:CONTRIBUTING.adoc[CONTRIBUTING.adoc].
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.