docs: split the README into a landing page and CONTRIBUTING

Browse Source

The README was two documents in one, and neither reader was served by
the other's half. It opened on a feature list, then spent its second
half on Go versions, WebKitGTK packages and `make` targets — while its
install table named a `darwin-universal.app.zip` and a
`windows-amd64.exe` that nothing has ever produced, and its header
claimed Windows and never mentioned Android, which is the one platform
with a published, self-updating channel.

So this is a correctness pass as much as a friendliness one. The README
now answers a user's questions only: what the app is, three screenshots
from the seeded fixture library so anyone can retake them, the four
formats, one install section per channel that names what is actually
published, first run, where the data lives, and pointers out. The
version-restart note is linked to the two documents that own it rather
than copied, because a copy is a second thing to keep true.

CONTRIBUTING.md takes the technical half: prerequisites, the system
libraries, the build and codegen commands, which verification tier a
change demands, the tracker workflow, the commit grammar and the style
rules. CLAUDE.md is unchanged apart from one paragraph naming the split
— it was already the deep reference both of the others point at, and
stays the only one of the three that explains why a shape is what it is.

Closes #50

...

This commit is contained in:

logan

2026-08-26 03:37:13 -04:00

parent 245647f12b

commit 1c08d8db90

6 changed files with 296 additions and 80 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

docs/images/album.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 83 KiB

docs/images/home.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 285 KiB

docs/images/library.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 128 KiB