Rewrite overlay README

This commit is contained in:
wfalkowski committed 2026-10-18 14:46:06 +00:00
1 parent 3f81d8a074
commit c9f8a47fbc
1 file changed
+11 -41
+11 -41
View File
@@ -1,10 +1,13 @@
# wfalkowski-overlay # wfalkowski-overlay
A personal Gentoo repository for packages I maintain. It contains `gui-apps/wayter`, a Rust and GTK 4 greetd client for Wayland sessions, and `gui-apps/wayfinder`, a GTK 4 file manager. A personal Gentoo overlay for desktop software I maintain, with an emphasis on Linux and Wayland.
Wayter presents the login UI; greetd and the system's PAM stack handle authentication. The package installs the `wayter` executable and a sample palette. It does not install or configure greetd, PAM, or a compositor, so those need to be set up on the host. ## Packages
## Add the repository - [`gui-apps/wayter`](https://git.anchorhost.eu/wfalkowski/wayter): a graphical greeter client for greetd. Greetd and the host's PAM setup handle authentication; the overlay does not configure a login service or compositor.
- [`gui-apps/wayfinder`](https://git.anchorhost.eu/wfalkowski/wayfinder/): a GTK 4 file manager with a places sidebar and previews for supported text files and images. It installs a desktop menu entry.
## Enable the overlay
Create `/etc/portage/repos.conf/wfalkowski-overlay.conf`: Create `/etc/portage/repos.conf/wfalkowski-overlay.conf`:
@@ -15,51 +18,18 @@ masters = gentoo
priority = 50 priority = 50
``` ```
Wayter is keyworded `~amd64`. Accept that keyword in `/etc/portage/package.accept_keywords/wayter`: Both packages are keyworded `~amd64`. Add them to `/etc/portage/package.accept_keywords/wfalkowski-overlay` if you want to install either package:
```text ```text
gui-apps/wayter ~amd64 gui-apps/wayter ~amd64
```
Review the planned build, then install:
```sh
emerge -pv gui-apps/wayter
emerge -av gui-apps/wayter
```
Portage builds against the host Rust toolchain and GTK 4 with its Wayland backend. The ebuild uses the Gentoo `cargo` eclass and locked crate versions from the source `Cargo.lock`; no network access is needed during the build itself.
## Palette
The package installs `/usr/share/wayter/colors.ini.example`. Wayter reads its active palette from `~/.config/wayter/colors.ini`, relative to the greeter process's home directory. Copy the example there, then make sure the greeter account can read it. Editing the example under `/usr/share` won't change the active colors.
## Package source and updates
`gui-apps/wayter/wayter-0.1.0.ebuild` pins the source archive to a specific commit of [the Wayter repository](https://git.anchorhost.eu/wfalkowski/wayter). Cargo dependencies are recorded as individual distfiles in `CRATES`, with checksums in `Manifest`.
When updating the package, change `PV` through the ebuild filename and update the pinned source commit and crate list from the matching `Cargo.lock`. Regenerate the manifest with:
```sh
ebuild gui-apps/wayter/wayter-<version>.ebuild manifest
```
Then inspect the diff and test dependency resolution before committing. Keep the source revision and lockfile in sync; otherwise Portage may fetch a crate set that doesn't match the checked-out application.
## Wayfinder
Wayfinder is available at `gui-apps/wayfinder/wayfinder-0.1.0.ebuild`. Its source is fetched from the `0.1` release tag of [the Wayfinder Git repository](https://git.anchorhost.eu/wfalkowski/wayfinder/).
The package installs the `wayfinder` executable and `dev.wfalkowski.Wayfinder.desktop` under `/usr/share/applications`, so Wayfinder appears in desktop application menus.
After configuring this overlay in Portage as described above, accept the `~amd64` keyword and install the package:
```text
gui-apps/wayfinder ~amd64 gui-apps/wayfinder ~amd64
``` ```
Review the proposed build, then install the package you want:
```sh ```sh
emerge -pv gui-apps/wayfinder emerge -pv gui-apps/wayfinder
emerge -av gui-apps/wayfinder emerge -av gui-apps/wayfinder
``` ```
Replace `gui-apps/wayfinder` with `gui-apps/wayter` to install Wayter. Wayter needs a working greetd, PAM, and compositor configuration on the host.