A README that draws itself, in two languages - #17
Merged
Conversation
The hero is an animated SVG generated by tools/make_hero.py: 232 real strokes out of examples/motorcycle.jpg, appearing in the order the program sends them to a phone. Twice the size on screen at a third the bytes of a GIF, and sharp at any density. English and Russian are separate files now - README.md and README.ru.md, each with a link to the other - rather than one file with half of itself folded into a details block nobody opens. Both are about half the length they were: the deep material moved to docs/INTERNALS.md, which is where somebody looking for the digitizer's coordinate space or the three ways into a device will actually look. Two notes for the next person editing them. GitHub's sanitiser drops id attributes, so an in-page anchor has to be a preceding <a name>. And SMIL cannot restart document time, so every stroke in the hero animates on one indefinite cycle with its own keyTimes rather than on a begin offset - the first version played once and went blank.
MAXAWER
force-pushed
the
docs/readme-landing
branch
from
August 27, 2026 16:14
dd55150 to
0fa9534
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The hero
docs/hero.svg, generated bytools/make_hero.py: 232 real strokes out ofexamples/motorcycle.jpg, appearing in the order the program sends them to a phone. It is the product working, not a picture of it - and at 94 KB it is a third of the GIF it replaces while being sharp at any density.Two things had to be found out rather than assumed. SMIL cannot restart document time, so the first version played once and went blank; every stroke now animates on one indefinite cycle with its own
keyTimes. And GitHub's sanitiser dropsidattributes, so an in-page anchor has to be a preceding<a name>.Two languages, half the length
README.mdandREADME.ru.md, each linking to the other, instead of one file with the Russian half folded into a<details>nobody opens. English went from 629 lines to 278.The deep material moved to
docs/INTERNALS.md: the digitizer's own coordinate space, the three ways into a device and why a recent Pixel refuses the fast one, the 0/1/6 ms measurement, recordings, mirroring, and the open ends. That is where somebody actually goes looking for it, and it keeps the front page a front page.Also fixed along the way: the Russian install table had two
Linuxrows and told people to install a[gui]extra that no longer exists, anddocs/RELEASING.mdstill described the old--dmgand--archiveflags and a Tk window that is gone.Every relative link in all three files resolves.