convertablet/README.md
Yuki Joou 813aa15886 configs: Added example hooks for the daemon
This commit also adds documentation for hooks to the README
2023-07-14 20:14:51 +02:00

51 lines
887 B
Markdown

# 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
### Daemon configuration
You can create scripts at $HOME/.config/convertablet/hooks that will trigger on
events
- Basestation disconnected: basestation-disconnected-hook
- Basestation connected: basestation-connected-hook
### Configurations
Still a work in progress...