tsukasa/page
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
tsukasa 2026-08-13 19:27:09 +08:00
parent 11800a9a0c
commit 567a988f92
2 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -31,7 +31,7 @@ ninja -C build
./build/page ./build/page
``` ```
Or, for a standalone wrapped binary (nixOS only): Or, for a standalone wrapped binary (NixOS only):
```sh ```sh
nix build nix build
@ -48,4 +48,18 @@ page -h # help page
``` ```
See `config.h` for keybindings, default URI, data directory, and other See `config.h` for keybindings, default URI, data directory, and other
tweakable settings and stuff. 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

12
patches/README.md
View file

@ -1,12 +0,0 @@
# page patches
This directory exists for optional, user-submitted patchs for page.
To submit a patch, create a pull request, with the modified version
of your patched files. This will generate a diff, which will be added
into this directory after my approval. Ideally, you should include a
README.md (or just a plain text README) in the pull request's comment
section, explaining what the patch does.
# Current patches
No Patches yet