From 2380a9775bcf8b0e0b7b1b9ae4e103ba465455e0 Mon Sep 17 00:00:00 2001
From: Yuki Joou <yukijoou@laposte.net>
Date: Fri, 14 Jul 2023 20:03:57 +0200
Subject: [PATCH] README: Added basic usage instructions

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1a6c1f4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# convertablet
+
+Support for tablet-laptop convertible on wlroots-based compositors.
+
+This project includes both a daemon for handling screen rotation and docking,
+and some configuration for other software
+
+## Installation
+
+### Daemon
+
+1. Get the code
+
+```bash
+git clone https://git.kemonomimi.gay/yukijoou/convertablet && cd convertablet
+```
+
+2. Download and build the wayland extensions
+
+```bash
+cd wayland-protos/
+./download_protocols.sh
+./codegen.sh
+cd ../
+```
+
+3. Build the daemon
+
+```bash
+./build.sh
+```
+
+4. Run it to try it out
+
+```
+./convertablet
+```
+
+5. Copy it to /usr/local/bin & make it run at startup
+
+### Configurations
+
+Still a work in progress...