docs(readme): add build from source

boltgolt · Dec 23, 2023 · 17c49b2 · 17c49b2
1 parent 5b8451d
commit 17c49b2
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -71,6 +71,27 @@ _Maintainer: [@dmafanasyev](https://github.com/dmafanasyev)_
 
 Go to the [openSUSE wiki page](https://en.opensuse.org/SDB:Facial_authentication) for detailed installation instructions.
 
+### Building from source
+
+If you want to build Howdy from source, a few dependencies are required.
+
+#### Dependencies
+
+- Python 3.6 or higher
+- meson version 0.64 or higher
+- ninja
+- INIReader (can be pulled from git automatically if not found)
+- libevdev
+
+#### Build
+
+```sh
+meson setup build
+meson compile -C build
+```
+
+You can also install Howdy to your system with `meson install -C build`.
+
 ## Setup
 
 After installation, Howdy needs to learn what you look like so it can recognise you later. Run `sudo howdy add` to add a face model.

diff --git a/howdy/src/pam/README.md b/howdy/src/pam/README.md
@@ -1,6 +1,6 @@
 # Howdy PAM module
 
-## Prepare
+## Requirements
 
 This module depends on `INIReader` and `libevdev`.
 They can be installed with these packages: