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.
This commit is contained in:
RubbaBoy
parent
b62baab140
commit
6bb8e9c254
4 changed files with 55 additions and 65 deletions
13
CONTRIBUTING.md
Normal file
13
CONTRIBUTING.md
Normal file
|
|
@ -0,0 +1,13 @@
|
||||||
|
# Contributing Guidelines
|
||||||
|
|
||||||
|
Contributing entails that all contributions follow the [MPL 2.0 license](https://github.com/buffet/kiwmi/blob/master/LICENSE).
|
||||||
|
|
||||||
|
## Opening Issues
|
||||||
|
|
||||||
|
- Ensure that bugs have proper steps to reproduce
|
||||||
|
- Include program version, along with any system specs that may help identify the issue
|
||||||
|
|
||||||
|
## Committing
|
||||||
|
|
||||||
|
Commit messages should be both _clear_ and _descriptive_. If possible, commit titles should start with a verb describing the change. Don't be shy to include additional information such as motivation for the change in the commit body. Be sure to ensure other developers will be able to understand _why_ a specific change has occurred in the future.
|
||||||
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
||||||
Contribution Guidelines
|
|
||||||
=======================
|
|
||||||
|
|
||||||
NOTE: contributing implies that your contributions get licensed under the terms of MPL 2.0.
|
|
||||||
|
|
||||||
Opening Issues
|
|
||||||
--------------
|
|
||||||
|
|
||||||
- Make sure you have a GitHub account.
|
|
||||||
- Include steps to reproduce, if it is a bug.
|
|
||||||
- Include information on what version you are using.
|
|
||||||
|
|
||||||
Submit Changes
|
|
||||||
--------------
|
|
||||||
|
|
||||||
Commit messages should be both clear and descriptive.
|
|
||||||
If possible they should start with the verb that describes the change.
|
|
||||||
Don't be shy to include additional information, like motivation, for that change below the initial line.
|
|
||||||
|
|
||||||
Other developers should be able to understand why a change occurred, when looking at it at a later point in time.
|
|
||||||
42
README.md
Normal file
42
README.md
Normal file
|
|
@ -0,0 +1,42 @@
|
||||||
|
<h1 align="center">kiwmi</h1>
|
||||||
|
<p align="center"><i>A fully programmable Wayland Compositor.</i></p>
|
||||||
|
<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" />
|
||||||
|
<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, 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.
|
||||||
|
|
||||||
|
|
||||||
|
## Getting Started
|
||||||
|
|
||||||
|
The dependencies required are:
|
||||||
|
|
||||||
|
- [wlroots](https://github.com/swaywm/wlroots)
|
||||||
|
- meson (building)
|
||||||
|
- ninja (building)
|
||||||
|
- git (source control)
|
||||||
|
|
||||||
|
### Building
|
||||||
|
|
||||||
|
After cloning/downloading the project and ensuring all dependencies are installed, building is as easy as running
|
||||||
|
|
||||||
|
```
|
||||||
|
$ meson 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.
|
||||||
45
README.txt
45
README.txt
|
|
@ -1,45 +0,0 @@
|
||||||
kiwmi
|
|
||||||
=====
|
|
||||||
|
|
||||||
kiwmi is a Wayland compositor that is programmed by the user.
|
|
||||||
This means that the sky is the limit:
|
|
||||||
You can implement any tiling or floating logic you want; even stuff like modal window management becomes easy.
|
|
||||||
|
|
||||||
This means there is a steep entrance barrier, but in the future there will be base configurations to start with.
|
|
||||||
|
|
||||||
NOTE: This whole project is a work in project, and not usable yet.
|
|
||||||
|
|
||||||
Installation
|
|
||||||
------------
|
|
||||||
|
|
||||||
Make sure all dependencies are installed.
|
|
||||||
|
|
||||||
Run:
|
|
||||||
|
|
||||||
$ meson build
|
|
||||||
$ ninja -C build
|
|
||||||
|
|
||||||
Install with:
|
|
||||||
|
|
||||||
# ninja -C build install
|
|
||||||
|
|
||||||
Dependencies
|
|
||||||
------------
|
|
||||||
|
|
||||||
- wlroots (https://github.com/swaywm/wlroots)
|
|
||||||
- meson (build)
|
|
||||||
- ninja (build)
|
|
||||||
- git (build, optional, to fetch the version)
|
|
||||||
|
|
||||||
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 CONTRIBUTING.txt.
|
|
||||||
|
|
||||||
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.
|
|
||||||
Loading…
Reference in a new issue