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

Overhaul readme

Browse source
This commit is contained in:
buffet 2019-12-22 16:50:08 +00:00
parent 6bb8e9c254
commit 2b7bc885d2
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
README.md
View file

@ -1,13 +1,14 @@
<h1 align="center">kiwmi</h1> <h1 align="center">kiwmi</h1>
<p align="center"><i>A fully programmable Wayland Compositor.</i></p> <p align="center"><i>A fully programmable Wayland Compositor</i></p>
<hr><p align="center"> <hr><p align="center">
<a href="http://hits.dwyl.io/buffet/kiwmi"><img alt="HitCount" src="http://hits.dwyl.io/buffet/kiwmi.svg" /></a>
<img alt="Stars" src="https://img.shields.io/github/stars/buffet/kiwmi.svg?label=Stars&style=flat" /> <img alt="Stars" src="https://img.shields.io/github/stars/buffet/kiwmi.svg?label=Stars&style=flat" />
<a href="https://github.com/buffet/kiwmi/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/buffet/kiwmi.svg"/></a> <a href="https://github.com/buffet/kiwmi/issues"><img alt="GitHub issues" src="https://img.shields.io/github/issues/buffet/kiwmi.svg"/></a>
<a href="https://github.com/buffet/kiwmi/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/buffet/kiwmi"></a> <a href="https://github.com/buffet/kiwmi/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/buffet/kiwmi"></a>
</p> </p>
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 ## Getting Started
@ -17,7 +18,7 @@ The dependencies required are:
- [wlroots](https://github.com/swaywm/wlroots) - [wlroots](https://github.com/swaywm/wlroots)
- meson (building) - meson (building)
- ninja (building) - ninja (building)
- git (source control) - git (build, optional)
### Building ### Building
@ -31,12 +32,13 @@ $ ninja -C build
Installing is accomplished with the following command: Installing is accomplished with the following command:
``` ```
$ ninja -C build install # ninja -C build install
``` ```
## Contributing ## 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. For clarifications or suggestions on anything, please don't hesitate to contact me.