From 737743c261c575e03b7091f23c1395fe8d9cce28 Mon Sep 17 00:00:00 2001 From: eliott Date: Thu, 2 Apr 2026 15:41:02 +0200 Subject: [PATCH] docs: clean up README Remove duplicate sections, update supported display managers list (GDM, SDDM, LightDM), consolidate install/uninstall instructions. Co-Authored-By: Claude Opus 4.6 (1M context) --- README.md | 41 +++++++---------------------------------- 1 file changed, 7 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index eb3d817..2178e88 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ **Windows Hello-style face authentication for Linux** -Unlock your computer with your face using your laptop's IR camera. Works with GDM (GNOME/Zorin) lock screen and login — your password always works as a fallback. +Unlock your computer with your face using your laptop's IR camera. Works with GDM, SDDM, and LightDM — your password always works as a fallback. [![License: GPL-3.0](https://img.shields.io/badge/License-GPL--3.0-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) [![Rust](https://img.shields.io/badge/Rust-1.75+-orange.svg)](https://www.rust-lang.org/) @@ -26,26 +26,17 @@ Phone screens are invisible to IR, so photos on a phone can't fool it. ## Tested on -| Hardware | OS | Status | -|----------|----|--------| -| Lenovo Yoga Pro 7 (Chicony IR camera) | Zorin OS 17 (GNOME/GDM) | Working | +| Hardware | OS | Display Manager | Status | +|----------|----|-----------------|--------| +| Lenovo Yoga Pro 7 (Chicony IR camera) | Zorin OS 17 | GDM (GNOME) | Working | -Other laptops with Windows Hello-compatible IR cameras should work. If you test on different hardware, please open an issue to let us know. +Other laptops with Windows Hello-compatible IR cameras should work. GDM, SDDM, and LightDM are supported. If you test on different hardware, please open an issue to let us know. --- ## Install -### Requirements - -- A Linux laptop with a **Windows Hello-compatible IR camera** (check with `v4l2-ctl --list-devices` — look for a second camera labeled "IR" or "Integrated I") -- **Rust** 1.75+ and **Cargo** -- **GDM** display manager (GNOME, Zorin, Ubuntu) -- Packages: `libpam0g-dev`, `v4l-utils`, `build-essential` - -### Install - -You need [Rust](https://rustup.rs/) installed. Then: +You need [Rust](https://rustup.rs/) and a **Windows Hello-compatible IR camera**. ```bash git clone https://gitea.lab48.be/eliott/Linux-Hello.git @@ -57,7 +48,7 @@ The installer handles everything: dependencies, build, ONNX models, IR emitter s When it's done, lock your screen and look at the camera. -### Uninstall +To uninstall: ```bash ./install.sh --uninstall @@ -119,24 +110,6 @@ min_score = 0.7 --- -## Uninstall - -```bash -# Remove PAM line -sudo sed -i '/pam_linux_hello/d' /etc/pam.d/gdm-password - -# Stop and disable service -sudo systemctl disable --now linux-hello.service - -# Remove files -sudo rm -f /usr/libexec/linux-hello-daemon /usr/local/bin/linux-hello -sudo rm -f /lib/x86_64-linux-gnu/security/pam_linux_hello.so -sudo rm -f /etc/systemd/system/linux-hello.service -sudo rm -rf /etc/linux-hello /var/lib/linux-hello /usr/share/linux-hello -``` - ---- - ## Contributing Contributions welcome — especially: