README: Added basic usage instructions

This commit is contained in:
Yuki Joou 2023-07-14 20:03:57 +02:00
parent ca7e8e5e44
commit 7079319692

43
README.md Normal file
View file

@ -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...