page/README.md
2026-08-13 19:27:09 +08:00

65 lines
1.3 KiB
Markdown

# page
A minimal WebKitGTK viewer. Inspired by [surf](https://surf.suckless.org/),
but without the XEmbed dependency, so it actually works under pure Wayland.
## Dependencies
- `pkg-config`
- `meson`
- `ninja`
- `wrapGAppsHook3`
- `gtk4`
- `webkitgtk_6_0`
- `glib-networking`
- `gsettings-desktop-schemas`
- `cacert`
- `gstreamer`
- `gst-plugins-base`
- `gst-plugins-good`
- `gst-plugins-bad`
- `gst-plugins-ugly`
- `gst-libav`
## Building
```sh
nix develop (on NixOS)
meson setup build
ninja -C build
./build/page
```
Or, for a standalone wrapped binary (NixOS only):
```sh
nix build
./result/bin/page
```
## Usage
```rc
page
page example.com
page some search terms # searches Google by default
page -h # help page
```
See `config.h` for keybindings, default URI, data directory, and other
tweakable settings and whatnot.
# Patches for page
To submit a patch, create a pull request with your patch in question
in the patches/* directory in its own subdirectory, alongside a README
explaining the patch. After review and testing, if the patch works and
is simple enough to maintain, I will merge your pull request as a patch
(as pull request merging isn't a thing on hgforge yet, unfortunetely),
crediting you as the author of the patch, if the README.md does not
contain credit for it beforehand.
# License
GNU Public License Version 3