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

56 lines
1.9 KiB
Markdown
Raw Normal View History

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-22 02:36:48 +00: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-22 02:36:48 +00: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-22 02:36:48 +00:00
Add link to docs to the readme
2021-08-09 18:58:16 +00:00
## Documentation
Documentation for the API can be found in [lua_docs.md](lua_docs.md).
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-22 02:36:48 +00: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-22 02:36:48 +00: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-22 02:36:48 +00: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-22 02:36:48 +00: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-22 02:36:48 +00:00
Overhaul readme
2019-12-22 16:50:08 +00:00
For clarifications or suggestions on anything, please don't hesitate to contact me.
Reference in a new issue Copy permalink