Skip to content

docs: make README outcome clear in 30 seconds - #97

Merged
renezander030 merged 1 commit into
masterfrom
docs/readme-30-second-quickstart
Aug 25, 2026
Merged

docs: make README outcome clear in 30 seconds#97
renezander030 merged 1 commit into
masterfrom
docs/readme-30-second-quickstart

Conversation

@renezander030

Copy link
Copy Markdown
Owner

Summary

  • lead with the editable CapCut/JianYing project outcome and existing output example
  • put installation and a three-command video-plus-caption quickstart before the detailed inventory
  • condense the upgrade advisory while preserving the OG card, legal disclaimer, release notes, and sponsor section

Validation

  • git diff --check
  • all local README links resolve
  • GitHub Markdown render verified the hero, Important advisory, release notes, and sponsor section
  • tests not run (README-only change)

@renezander030
renezander030 marked this pull request as ready for review August 25, 2026 05:10
@renezander030
renezander030 merged commit 9f1239c into master Aug 25, 2026
8 checks passed
renezander030 added a commit that referenced this pull request Aug 28, 2026
… portability, discovery) (#98)

* feat(sync-timelines): opt-in --nested repair for Timelines/<id>/ documents (#50)

* feat(lint): --pip validation report for the PIP + local-mask workflow (#78)

* feat(catalogue): cross-category name/id lookup over bundled + harvested resources

* fix(hooks): pre-commit test gate reported tail's exit status, not the suite's

* feat(lint): observe-only media-unregistered sidecar note (pyCapCut#13)

* feat(import): --clone-style copies the draft's existing caption look without a segment id

* feat: relink --stage, fixture --check, tagged write refusals

- relink --stage copies each relinked video/audio into assets/<kind>/ and
  points the material at the copy, so the repaired draft is portable
  (pyJianYingDraft#177)
- fixture --check scans the finished bundle (SANITIZE_REPORT.json and README
  included) for residual home paths, emails, device ids and the account name,
  with file:line findings and a non-zero exit; a bundle dir as the argument
  re-checks without rebuilding (#50, #59)
- every write refusal now names its gate - refused [editor-open] /
  [version-boundary] / [draft-changed-on-disk] / [mirror-newer] - so the next
  pasted stderr line is unambiguous about which gate fired (#50 side finding)

* feat(catalogue): register the command in describe/completions and regenerate the reference

* docs(zh): README parity with the #97 restructure, version-support + encryption translations, v0.21.0 highlights

* release: v0.21.0 — nine opportunity-mined items (the #50 repair path, portability, discovery)

* fix(fixture): --check works on home-dir projects

Two composed bugs, found by smoking a bundle built under /home instead of
/tmp: the verify pass scanned report.out_dir, which is itself redacted
(/home/USER/...) and so not a filesystem path; and the home-path scan
flagged the redactor's own USER placeholder, which every correctly
redacted home-dir bundle (and every Windows/macOS temp dir) contains.
The check now scans the real --out path and captures the account segment
so exactly the USER placeholder passes.
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