diff --git a/README.md b/README.md index 696187b..aac6f0d 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,9 @@ 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 -### Daemon +### Installation 1. Get the code @@ -33,12 +33,19 @@ cd ../ 4. Run it to try it out ``` -./convertablet +./convertablet generic ``` +This will run the daemon in 'generic' mode. This assumes "sane defaults" for +your display's name and motion sensor. It's likely your device isn't using +those. + +You can check the list of supported devices with `./convertablet list-devices`, +and load that specific device's config with `./convertablet `. + 5. Copy it to /usr/local/bin & make it run at startup -### Daemon configuration +### Configuration You can create scripts at $HOME/.config/convertablet/hooks that will trigger on events @@ -46,6 +53,23 @@ events - Basestation disconnected: basestation-disconnected-hook - Basestation connected: basestation-connected-hook -### Configurations +### Device compatibility + +| Product name | Device name | +|-----------------------|-------------------------| +| Lenovo Miix 320-10icr | `lenovo-miix-320-10icr` | + +## Using fcitx hooks + +If you're using fcitx to get fancy input methods working, on-screen keyboards +will not work, because on wayland, only one program can detect input begining +events. To work around this issue, you can use the `fcitx5-hooks` module I wrote +to run a script when an input field is focused/unfocused. See instructions in +[fcitx5-hooks/](./fcitx5-hooks/). + +## 3rd party programs Configurations Still a work in progress... + +In the meantime, you can find some example hooks for the convertablet daemon and +waybar in [configs/](./configs/).