Repository navigation
Docs, help and a new README reel - #21
Merged
Merged
Conversation
CPritch
commented
Oct 6, 2026
CPritch
commented
Owner
- New README header: a 2 MB animated AVIF of a forest path, round stones and a rock face showing the parallax and three transitions, in place of the 17.9 MB tiger GIF.
- Every command's help ends with examples, and commands are listed in the order you'd use them. A test parses every example.
- shiftpaperd --help and --version work, instead of starting a second daemon.
- Man pages and bash, zsh and fish completions, generated from the same definitions as --help. The AUR packages install them, and a test fails if they're out of date.
- docs/ covers the config file, transitions (with a clip of each), depth models and troubleshooting.
- A shorter README quick start.
The tiger GIF was 17.9 MB and barely showed the parallax. The new reel is an animated AVIF at 960x600 and 30 fps, 2 MB, rendered offscreen by the real renderer with a scripted cursor. It goes from a forest path to a beach of stones with tide-in, to a rock face with sweep-out, and back to the path with portal, all baked with MoGe-2 ViT-B. The photos are CC0 from Wikimedia Commons, credited under the reel anyway.
Each shiftpaper command now ends its help with a few examples, and the top-level help points at `shiftpaper help <command>`. Commands are listed in the order you'd need them, so fetch-model comes first and bake last. A test parses every example, so they can't drift from the real flags. shiftpaperd ignored its arguments, so `shiftpaperd --help` started a second daemon. It now has --help and --version, describes its config file, signals and logging, and rejects anything else. Help text wraps to the terminal width.
`man shiftpaper`, a page for each command and `man shiftpaperd` are made
from the same definitions as --help, along with bash, zsh and fish
completions. They live in assets/ and the AUR packages install them.
Tests in the CLI and daemon fail if they're out of date. After changing
the help, update them with:
SHIFTPAPER_REGENERATE=1 cargo test generated
The man page helper sits in the config crate behind a `man` feature that
only the tests turn on, so neither binary gets any bigger.
Plainer wording for set, bake, fetch-model, mode and --model, and for the two tracking modes. bake's summary now says what it's for: baking an image without setting it.
docs/ has short pages on the config file, transitions, depth models and troubleshooting. The transitions page has a clip of each one, rendered by the real renderer. The clips are left out of release tarballs. The README's quick start is now three commands to get going and three to try next, after a note that every command has its own help. Tracking modes and the model list moved into the docs, and the systemd step for cargo installs moved into Install.
Updated the transition description for 'tide-in' to soften the claim around lapping around objects.
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
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.