Update README

This commit is contained in:
phil 2023-07-16 12:21:58 +02:00
parent c1914511ee
commit 8b0a4c954c
1 changed files with 4 additions and 19 deletions

View File

@ -1,26 +1,11 @@
# tablet-mode
# Chuwi Minibook tablet mode switch
Allow users to toggle a convertible laptop between laptop and tablet mode.
Allow users to toggle a Chuwi Minibook laptop between laptop and tablet mode.
## Configuration
## Installation
The devices to be deactivated in either *tablet* or *laptop* mode must be specified in `/etc/tablet-mode.json`.
You can specify whether desktop notifications shall be send when changing the mode using the `notify` flag.
If specified, you can override `sudo` to provide another program that accepts commands to be run as root without a password
by the current user to elevate privileges, such as *doas*.
```json
{
"tablet": [
"/dev/input/by-path/platform-i8042-serio-0-event-kbd",
"/dev/input/by-path/platform-i8042-serio-1-event-mouse"
],
"notify": false,
"sudo": "/usr/bin/doas"
}
```
Just run `install.sh` and enter the name of you local user account.
## Usage
You must be a member of the group `tablet` to toggle between tablet and laptop mode.
You can toggle between tablet and laptop mode by running `setsysmode toggle` or use the desktop icon provided with this package.