docs: document AUR and release installation
- commit
- 8cd9673d06da4858ab60e2e746c5610c03484130
- author
- brice · · 2026-10-01 03:06 UTC
- parent
- 1a6f38b
- signature
- GPG Verified
CD88F9E564E0102646FB6077A1A07C7C7C3E349D· arch-gpg Verified for the committer email
1 file · +12 -3
M README.md +12 -3
| @@ -24,14 +24,23 @@ It uses standard protocols only: `ext-idle-notify-v1`, `ext-session-lock-v1`, `w | |||
| 24 | 24 | ||
| 25 | 25 | ## Install | |
| 26 | 26 | ||
| 27 | - | Arch Linux: `make pkg` builds a package of the committed HEAD from `packaging/arch/PKGBUILD` into `dist/`, and `make install` installs it with pacman. `packaging/aur/neferafk-git/PKGBUILD` builds the latest `main`. | |
| 27 | + | On Arch Linux, install from the AUR: | |
| 28 | 28 | ||
| 29 | - | From source: | |
| 29 | + | ```sh | |
| 30 | + | paru -S neferafk-bin # latest release, pre-built | |
| 31 | + | paru -S neferafk-git # latest main, built from source | |
| 32 | + | ``` | |
| 33 | + | ||
| 34 | + | Pre-built archives are on the [releases page](https://github.com/bnema/neferafk/releases). To build from a checkout: | |
| 30 | 35 | ||
| 31 | 36 | ```sh | |
| 32 | - | CGO_ENABLED=0 go build -o bin/neferafk ./cmd/neferafk | |
| 37 | + | CGO_ENABLED=0 go build -o bin/neferafk ./cmd/neferafk # builds bin/neferafk | |
| 38 | + | make pkg # builds an Arch package of HEAD into dist/ | |
| 39 | + | make install # builds that package and installs it with pacman | |
| 33 | 40 | ``` | |
| 34 | 41 | ||
| 42 | + | The packages install `/etc/pam.d/neferafk` for password mode. | |
| 43 | + | ||
| 35 | 44 | ## Usage | |
| 36 | 45 | ||
| 37 | 46 | ``` | |
| @@ -24,14 +24,23 @@ It uses standard protocols only: `ext-idle-notify-v1`, `ext-session-lock-v1`, `w | |||||
| 24 | 24 | ||||
| 25 | ## Install | 25 | ## Install | ||
| 26 | 26 | ||||
| 27 | - | Arch Linux: `make pkg` builds a package of the committed HEAD from `packaging/arch/PKGBUILD` into `dist/`, and `make install` installs it with pacman. `packaging/aur/neferafk-git/PKGBUILD` builds the latest `main`. | 27 | + | On Arch Linux, install from the AUR: |
| 28 | 28 | ||||
| 29 | - | From source: | 29 | + | ```sh |
| 30 | + | paru -S neferafk-bin # latest release, pre-built | |||
| 31 | + | paru -S neferafk-git # latest main, built from source | |||
| 32 | + | ``` | |||
| 33 | + | ||||
| 34 | + | Pre-built archives are on the [releases page](https://github.com/bnema/neferafk/releases). To build from a checkout: | |||
| 30 | 35 | ||||
| 31 | ```sh | 36 | ```sh | ||
| 32 | - | CGO_ENABLED=0 go build -o bin/neferafk ./cmd/neferafk | 37 | + | CGO_ENABLED=0 go build -o bin/neferafk ./cmd/neferafk # builds bin/neferafk |
| 38 | + | make pkg # builds an Arch package of HEAD into dist/ | |||
| 39 | + | make install # builds that package and installs it with pacman | |||
| 33 | ``` | 40 | ``` | ||
| 34 | 41 | ||||
| 42 | + | The packages install `/etc/pam.d/neferafk` for password mode. | |||
| 43 | + | ||||
| 35 | ## Usage | 44 | ## Usage | ||
| 36 | 45 | ||||
| 37 | ``` | 46 | ``` | ||