From 2b7bc885d21355f7afd8729a49b8f04dd8ecdc75 Mon Sep 17 00:00:00 2001 From: Charlotte Meyer Date: Sun, 22 Dec 2019 16:50:08 +0000 Subject: [PATCH] Overhaul readme --- README.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0a5a5d6..d1008a2 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,14 @@

kiwmi

-

A fully programmable Wayland Compositor.

+

A fully programmable Wayland Compositor


- HitCount 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, allowing for 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. +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 @@ -17,7 +18,7 @@ The dependencies required are: - [wlroots](https://github.com/swaywm/wlroots) - meson (building) - ninja (building) -- git (source control) +- git (build, optional) ### Building @@ -31,12 +32,13 @@ $ ninja -C build Installing is accomplished with the following command: ``` -$ ninja -C build install +# 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](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). +Contributions are welcomed, especially while the project is in a heavy WIP stage. +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). -For clarifications or suggestions on anything, please don't hesitate to contact me. \ No newline at end of file +For clarifications or suggestions on anything, please don't hesitate to contact me.