Skip to content

docs(readme): refresh homepage to house brand structure#1

Open
bgorzelic wants to merge 1 commit into
mainfrom
docs/readme-refresh
Open

docs(readme): refresh homepage to house brand structure#1
bgorzelic wants to merge 1 commit into
mainfrom
docs/readme-refresh

Conversation

@bgorzelic

Copy link
Copy Markdown
Owner

What changed

Visual refresh of the README to match the house brand structure used across the other repos (spookyjuice.ai, gmail-cleanup, spookywrt, etc.). Content got shorter (346 lines removed, 207 added), not just more decorated.

  • Bold value line + badge row under the H1: Python 3.11+ (from pyproject), FFmpeg, OpenCV, alpha status. No CI or license badges — no workflows and no LICENSE file exist to back them.
  • Proof first: a terminal transcript of the core workflow (initingest runanalyze run) derived from the actual Rich console strings in commands/init.py, commands/ingest.py, and commands/analyze.py — including the real init tree output (03_PROJECT/, 04_EXPORTS/), which the old README misrepresented.
  • "Why It's Different" capability table (VFR fix, HDR tonemap, scoring, timecode burn, FlightDeck fallback) and a mermaid pipeline diagram of the numbered project directories.
  • The 11-step usage walkthrough was condensed into Quick Start + a "Beyond the Core Pipeline" section; all command tables, preset/device/format/scoring tables, FlightDeck config, and troubleshooting kept.
  • Added an Honest Status section (alpha, v0.4.0, per pyproject classifiers).

Accuracy fixes

  • init new transcript now matches what the command actually prints (old README showed a directory tree init does not create).
  • Removed the pytest --cov=skyforge line from Development — the repo has no tests/ directory yet, so the command has nothing to run.

How to review

Render the README on the branch; every command and output string can be checked against src/skyforge/commands/ and pyproject.toml.

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