diff --git a/CLAUDE.md b/CLAUDE.md index e19f86c..2f9b7f7 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -61,8 +61,10 @@ Welcome to plasma-face-unlock `v1.4.0`! One or two sentences on what this releas - Second highlight ``` -A picture or a snippet of the menu under the welcome is optional. The highlights stay a plain list: -no heading or text per highlight, the list of commits explains the rest. +A picture under the welcome is optional. To show the menu or another screen of the program, use a +real screenshot of it running in Konsole, in English. Never a text copy of the screen. The same goes +for the README. The highlights stay a plain list: no heading or text per highlight, the list of +commits explains the rest. A patch release is just a sentence or two, for example: "A small patch. The menu no longer closes when you press Enter." The list of commits follows on its own. diff --git a/README.md b/README.md index 4ff2a3a..3b8cad6 100644 --- a/README.md +++ b/README.md @@ -72,16 +72,22 @@ You need Plasma 6 on Wayland and a camera. Infrared cameras (the Windows Hello k plasma-face-unlock ``` -This opens a menu. Press **1** and follow the setup window: look at the camera, then turn your head -slowly in a circle until the ring is full. Then lock the screen and look at it. +This opens a menu: -| Key | | -|---|---| -| **1** | Turn face unlock on or off | -| **2** | Add another face, for example with glasses | -| **3** | Rename, turn off or delete faces | -| **4** | Settings: sudo, admin prompts, photo check, camera, bubble style, animation speed and more | -| **5** | One test scan that shows what the camera sees. Try this first when something does not work. | +

+ The plasma-face-unlock menu in Konsole: face unlock on, one face, lock screen, sudo and admin prompts on +

+ +Press **1** and follow the setup window: look at the camera, then turn your head slowly in a circle +until the ring is full. Then lock the screen and look at it. **2** adds another face, for example +with glasses, and **5** runs one test scan that shows what the camera sees. Try that first when +something does not work. + +**4** opens the settings. The text at the bottom says what the selected one does: + +

+ The settings in Konsole, grouped into lock screen, password prompts, recognition and bubble, with the photo check explained at the bottom +

Without the menu: `plasma-face-unlock enable`, `disable`, `setup [NAME]`, `faces`, `remove ID`, `test` and `status`. diff --git a/res/screenshots/menu.png b/res/screenshots/menu.png new file mode 100644 index 0000000..f0301be Binary files /dev/null and b/res/screenshots/menu.png differ diff --git a/res/screenshots/settings.png b/res/screenshots/settings.png new file mode 100644 index 0000000..a03c88b Binary files /dev/null and b/res/screenshots/settings.png differ