Skip to content

Rewrite the README for Preview 4 - #15

Merged
HexCodeYT merged 1 commit into
mainfrom
dev/preview4-docs
Jul 26, 2026
Merged

HexCodeYT merged 1 commit into
mainfrom
dev/preview4-docs

Conversation

@HexCodeYT

Copy link
Copy Markdown
Owner

What changed

  • Replaces the repeated project-status and feature sections with one tester-focused README.
  • Puts the real Apple silicon install path, quarantine command, and smoke test near the top.
  • Explains automatic engine refresh during drag-and-drop upgrades and how Pause Cleaning is preserved.
  • Documents schemeless-link behavior with the exact YouTube and Amazon examples used during testing.
  • Keeps the safety model, CLI commands, build steps, architecture, and rule contribution path without repeating them.
  • Updates the launch, macOS, menu bar, and release docs for Preview 4.

Why

The old README mixed user installation, internal launch planning, project status, and developer reference material. It also repeated claims and retained stale text from before public releases existed. Preview 4 needs a short path that matches the behavior testers have now verified.

Verification

  • Humanizer pass for repetitive, promotional, and formulaic wording
  • cargo fmt --check
  • cargo test
  • cargo clippy --all-targets -- -D warnings
  • git diff --check

All checks pass.

@HexCodeYT
HexCodeYT marked this pull request as ready for review July 26, 2026 12:34
@HexCodeYT
HexCodeYT merged commit 97d464c into main Jul 26, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant