eliott/Linux-Hello
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: clean up README

Browse Source 
Remove duplicate sections, update supported display managers list
(GDM, SDDM, LightDM), consolidate install/uninstall instructions.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
eliott
2026-04-02 15:41:02 +02:00
parent 922f7aa0c9
commit 737743c261
1 changed files with 7 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -6,7 +6,7 @@
**Windows Hello-style face authentication for Linux** **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) [![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/) [![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 ## Tested on
| Hardware | OS | Status | | Hardware | OS | Display Manager | Status |
|----------|----|--------| |----------|----|-----------------|--------|
| Lenovo Yoga Pro 7 (Chicony IR camera) | Zorin OS 17 (GNOME/GDM) | Working | | 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 ## Install
### Requirements You need [Rust](https://rustup.rs/) and a **Windows Hello-compatible IR camera**.
- 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:
```bash ```bash
git clone https://gitea.lab48.be/eliott/Linux-Hello.git 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. When it's done, lock your screen and look at the camera.
### Uninstall To uninstall:
```bash ```bash
./install.sh --uninstall ./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 ## Contributing
Contributions welcome — especially: Contributions welcome — especially: