docs: show the menu and settings as konsole screenshots

This commit is contained in:
Felitendo committed 2026-09-24 01:39:10 +02:00
1 parent af72762508
commit 14119442e7
4 files changed
+19 -11

No files matched your search

+4 -2
View File
@@ -61,8 +61,10 @@ Welcome to plasma-face-unlock `v1.4.0`! One or two sentences on what this releas
- Second highlight - Second highlight
``` ```
A picture or a snippet of the menu under the welcome is optional. The highlights stay a plain list: A picture under the welcome is optional. To show the menu or another screen of the program, use a
no heading or text per highlight, the list of commits explains the rest. 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 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. when you press Enter." The list of commits follows on its own.
+15 -9
View File
@@ -72,16 +72,22 @@ You need Plasma 6 on Wayland and a camera. Infrared cameras (the Windows Hello k
plasma-face-unlock plasma-face-unlock
``` ```
This opens a menu. Press **1** and follow the setup window: look at the camera, then turn your head This opens a menu:
slowly in a circle until the ring is full. Then lock the screen and look at it.
| Key | | <p align="center">
|---|---| <img src="res/screenshots/menu.png" alt="The plasma-face-unlock menu in Konsole: face unlock on, one face, lock screen, sudo and admin prompts on" width="560">
| **1** | Turn face unlock on or off | </p>
| **2** | Add another face, for example with glasses |
| **3** | Rename, turn off or delete faces | Press **1** and follow the setup window: look at the camera, then turn your head slowly in a circle
| **4** | Settings: sudo, admin prompts, photo check, camera, bubble style, animation speed and more | until the ring is full. Then lock the screen and look at it. **2** adds another face, for example
| **5** | One test scan that shows what the camera sees. Try this first when something does not work. | 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:
<p align="center">
<img src="res/screenshots/settings.png" alt="The settings in Konsole, grouped into lock screen, password prompts, recognition and bubble, with the photo check explained at the bottom" width="680">
</p>
Without the menu: `plasma-face-unlock enable`, `disable`, `setup [NAME]`, `faces`, `remove ID`, Without the menu: `plasma-face-unlock enable`, `disable`, `setup [NAME]`, `faces`, `remove ID`,
`test` and `status`. `test` and `status`.
Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 KiB