Skip to content

README: highlights, screenshot slideshow and a feature request form - #14

Merged
Xarishark merged 10 commits into
mainfrom
docs/readme
Nov 8, 2026
Merged

Xarishark merged 10 commits into
mainfrom
docs/readme

Conversation

@Xarishark

Copy link
Copy Markdown
Owner

Redesigns the README for going public. Built on top of #13 (src/ regroup); once #13 merges, this PR shows only its own 4 commits.

README

  • Header with release, Windows 11 24H2+, CI and license badges, plus the download button.
  • A full-width animated slideshow (docs/images/slideshow.webp, lossless, 1.3 MB, 5 slides with captions and position dots), with every still in a collapsed "All screenshots" table.
  • Highlights lead with what sets Director apart: built-in TV control (LG, Samsung, TCL) with no external tools, scenes as one ordered flow with a single rollback, waiting for TV wake, input and HDMI audio, TV input protection, NVIDIA/RTSS FPS limits with a VRR-safe cap, leave/return steps, and detecting screens that are off.
  • A "What a scene can change" table, and a No helper tools needed section inviting requests to replace external CLI tools in Director's area.
  • Install, quick start, CLI, guides, contributing and license, tightened.

Screenshots

  • New captures of Scenes, the scene steps, Now, Displays and TV controls, all from preview fixtures with made-up data.
  • Test-only: the preview fixture fills Now with its demo screens and audio devices, and the fixture TVs are named "Living room TV".

Issue form

  • feature.yml asks what you want to do, which tool or script it would replace, and where you'd use it. CONTRIBUTING links it.

Verified

  • fmt, clippy -D warnings and the test build pass; each capture's text dump shows only fixture data; the README and docs link check is clean.
  • Not yet checked: how GitHub renders the README (the repo is private and the preview browser isn't signed in), and the shields.io release badge, which only resolves once the repo is public.

@Xarishark
Xarishark merged commit 915a5ad into main Nov 8, 2026
1 check passed
@Xarishark
Xarishark deleted the docs/readme branch November 8, 2026 16:22
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