From 8b0a4c954c86bce5af43844d35c32357e78bfbfc Mon Sep 17 00:00:00 2001 From: phil Date: Sun, 16 Jul 2023 12:21:58 +0200 Subject: [PATCH] Update README --- README.md | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 4afdc40..cdc0bc5 100644 --- a/README.md +++ b/README.md @@ -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.