docs: improve build from source

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

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -78,11 +78,24 @@ If you want to build Howdy from source, a few dependencies are required.
 #### Dependencies
 
 - Python 3.6 or higher
+  * pip
+  * setuptools
+  * wheel
 - meson version 0.64 or higher
 - ninja
 - INIReader (can be pulled from git automatically if not found)
 - libevdev
 
+To install them on Debian/Ubuntu for example:
+
+```
+sudo apt-get update && sudo apt-get install -y \
+python3 python3-pip python3-setuptools python3-wheel \
+cmake make build-essential \
+libpam0g-dev libinih-dev libevdev-dev \
+python3-dev libopencv-dev
+```
+
 #### Build
 
 ```sh

diff --git a/howdy/src/pam/README.md b/howdy/src/pam/README.md
@@ -19,7 +19,7 @@ it will be automatically pulled from git at the subproject's pinned version.
 
 ``` sh
 meson setup build
-ninja -C build
+ninja -C build # or meson compile -C build
 ```
 
 ## Install

diff --git a/meson.build b/meson.build
@@ -14,6 +14,6 @@ paths_dict = {
     'log_path': logpath,
 }
 
-# We need to keep this order beause howdy-gtk defines the gtk script path
+# We need to keep this order beause howdy-gtk defines the gtk script path which is used later in howdy
 subdir('howdy-gtk')
 subdir('howdy')