kiwmi/README.md

<h1 align="center">kiwmi</h1>
<p align="center"><i>A fully programmable Wayland Compositor</i></p>
<hr><p align="center">
  <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/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/buffet/kiwmi"></a>
</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, 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

The dependencies required are:

- [wlroots](https://github.com/swaywm/wlroots)
- meson (building)
- ninja (building)
- git (build, optional)

### Building

After cloning/downloading the project and ensuring all dependencies are installed, building is as easy as running

```
$ meson build
$ ninja -C build
```

If you plan to use luajit instead, use the following commands instead.

```
$ meson -Dlua-pkg=luajit build
$ ninja -C build
```

Installing is accomplished with the following command:

```
# 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).

For clarifications or suggestions on anything, please don't hesitate to contact me.


## Using

Since kiwmi does not have any logic in itself, all logic must be provided by lua scripts.
See the lua_docs.md for a ruleset for the lua files. To test a lua command / file, you can use the kiwmi client (kiwmic). 
By default, no lua configuration file is supplied. If you *really* want an example, you can look at https://github.com/zena1/kiwmi./blob/master/init.lua
Replaced README and CONTRIBUTING files The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown. 2019-12-21 21:36:48 -05:00			`<h1 align="center">kiwmi</h1>`
Overhaul readme 2019-12-22 16:50:08 +00:00			`<p align="center"><i>A fully programmable Wayland Compositor</i></p>`
Replaced README and CONTRIBUTING files The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown. 2019-12-21 21:36:48 -05:00			`<hr><p align="center">`
			`<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/graphs/contributors"><img alt="GitHub contributors" src="https://img.shields.io/github/contributors/buffet/kiwmi"></a>`
			`</p>`

Overhaul readme 2019-12-22 16:50:08 +00:00			`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.`
Replaced README and CONTRIBUTING files The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown. 2019-12-21 21:36:48 -05:00

			`## Getting Started`

			`The dependencies required are:`

			`- [wlroots](https://github.com/swaywm/wlroots)`
			`- meson (building)`
			`- ninja (building)`
Overhaul readme 2019-12-22 16:50:08 +00:00			`- git (build, optional)`
Replaced README and CONTRIBUTING files The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown. 2019-12-21 21:36:48 -05:00
			`### Building`

			`After cloning/downloading the project and ensuring all dependencies are installed, building is as easy as running`

			```
			`$ meson build`
			`$ ninja -C build`
			```

Allow user to change their lua version 2020-05-11 15:11:23 +00:00			`If you plan to use luajit instead, use the following commands instead.`

			```
			`$ meson -Dlua-pkg=luajit build`
			`$ ninja -C build`
			```

Replaced README and CONTRIBUTING files The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown. 2019-12-21 21:36:48 -05:00			`Installing is accomplished with the following command:`

			```
Overhaul readme 2019-12-22 16:50:08 +00:00			`# ninja -C build install`
Replaced README and CONTRIBUTING files The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown. 2019-12-21 21:36:48 -05:00			```


			`## Contributing`

Overhaul readme 2019-12-22 16:50:08 +00:00			`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).`
Replaced README and CONTRIBUTING files The previous README and CONTRIBUTING were both text, the readme being non-intriguing with nothing to really hook a user looking at the project. This doesn't need to be accepted, however I'd recommend using it as a reference or similar for a future rework of the readme. HTML can also be used if you don't want to use Markdown. 2019-12-21 21:36:48 -05:00
Overhaul readme 2019-12-22 16:50:08 +00:00			`For clarifications or suggestions on anything, please don't hesitate to contact me.`
Make a mention of kiwmic Added a small header of using. Once i can actually install kiwmi, i will update this again. 2020-07-17 21:23:35 +01:00

			`## Using`

			`Since kiwmi does not have any logic in itself, all logic must be provided by lua scripts.`
			`See the lua_docs.md for a ruleset for the lua files. To test a lua command / file, you can use the kiwmi client (kiwmic).`
			`By default, no lua configuration file is supplied. If you really want an example, you can look at https://github.com/zena1/kiwmi./blob/master/init.lua`