add a README v1 APPLIED

Pedro Lucas Porcellis: 1
 add a README

 1 files changed, 30 insertions(+), 0 deletions(-)

[PATCH] add a README Export this patch

---
Still needs to rig up the License information and the ticket tracker,
but I was unable to found those anywhere.

Feel free to amend this as you see fit.

 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8c9595b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# kaiju
+
+A Compositor for Pinephone. Loosely inspired by [Cage][cage] and
+[tinywl][tinywl]
+
+This project is a work in progress.
+
+## Building
+
+You'll need meson, wlroots (0.15.0) and xkbcommon.
+
+```
+meson build
+ninja -C build
+```
+
+To test from another Wayland Session, just set the environment variable
+`WAYLAND_DISPLAY` when executing commands, for example:
+
+```sh
+$ WAYLAND_DISPLAY=wayland-0 gnome-calculator
+```
+
+## Contributing
+
+Send patches to
+[~bl4ckb0ne/kaiju-dev@lists.sr.ht](https://lists.sr.ht/~bl4ckb0ne/kaiju-dev).
+
+[cage]: https://github.com/Hjdskes/cage
+[tinywl]: https://gitlab.freedesktop.org/wlroots/wlroots/-/blob/master/tinywl/tinywl.c
-- 
2.34.1

Simon Zeni <simon@bl4ckb0ne.ca>

2 years ago

Thanks for the initiative, the kaiju was in dire need of a README to indicate
what is going on.

I added more meat to your commit after creating an ticket tracker [1] and a
user mailing list [2]. I also made the #kaiju channel on IRC if you want to
join to discuss development.

Your patch has been applied in 161eae731603d192ed589c5b320d3e7979a65983.

Cheers!

[1]: https://todo.sr.ht/~bl4ckb0ne/kaiju
[2]: https://lists.sr.ht/~bl4ckb0ne/kaiju