Keep the README to what a user needs - #8
Merged
Merged
Conversation
Drops the Development section — the preview app and its flags, attaching to legacyScreenSaver to debug, `make release` — along with Install, and the two sections explaining what the backdrop cannot be. None of it means anything to someone who just wants a cat on their screen. What is left is what the saver does, what the Options do, the one bug worth warning about, and where the cat came from. It also loses the implementation names it was leaning on: framework and API names, bundle identifiers and source paths described the behaviour in terms of how it is built rather than what is seen.
winebarrel
force-pushed
the
readme-user-facing
branch
from
August 10, 2026 05:51
0c8a0ff to
9658f5a
Compare
winebarrel
enabled auto-merge
August 10, 2026 05:51
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 README had grown a developer half, and a set of sections about what the
backdrop cannot be. This drops both.
Gone
## Development— the preview app and its ten command-line flags, the noteabout attaching to
legacyScreenSaverbecause the saver cannot be run fromXcode, and
make release. Anyone who wants it will find it in the Makefile.## Install—make installis the developer's shortcut for getting a buildonto the machine it was built on. A
.saverinstalls by double-clicking it,so there is nothing here a user needs telling.
### Dynamic and video wallpapersand### Not the live desktop— bothexplained a limitation by describing the machinery behind it.
What is left
What the saver does, what the Options do, the one bug worth warning about, and
where the cat came from.
The remaining text also loses the implementation names it was leaning on —
NSWorkspace.desktopImageURL(for:),com.apple.NeptuneOneExtension,CGShieldingWindowLevel(),ScreenSaverDefaults,isVisible/sheetParent/occlusionState,Sources/Sprites.swift. They described the behaviour in termsof how it is built rather than what is seen. "Known issue" now says System
Settings loses track of the window the sheet belongs to, keeps the feedback
numbers and the forum link so it can be checked, and keeps the way out.
Options table, sprite provenance and licence are unchanged.