Skip to content

Prepare Director for a public repository - #11

Merged
Xarishark merged 13 commits into
mainfrom
chore/public-release
Nov 8, 2026
Merged

Xarishark merged 13 commits into
mainfrom
chore/public-release

Conversation

@Xarishark

@Xarishark Xarishark commented Nov 8, 2026 •

Copy link
Copy Markdown
Owner

Gets the repo ready to go public. No app behaviour changes.

License and notices

  • MIT LICENSE replaces the private rights notice; Cargo.toml gains license and repository.
  • THIRD_PARTY_LICENSES.md, generated with cargo-about (packaging/about.toml + about.hbs), covers the 122 crates compiled into director.exe. The MSI installs it and LICENSE.txt beside the executable.

README and community files

  • Drops the "private preview / requires access" wording; adds two screenshots taken from the preview fixture (no real device names).
  • Adds CONTRIBUTING.md, SECURITY.md (private vulnerability reporting), CHANGELOG.md (0.10.0–0.12.0), bug and crash issue forms, and a PR template. Blank issues stay enabled so the crash reporter's pre-filled issues/new link keeps working.

Docs

  • Consolidates docs/ from 19 files to 11, written for a fresh app (no "formerly", file versions, migrations or validation logs): user guides SCENES, DISPLAYS, SOUND, FPS, TVS, plus INSTALL, TROUBLESHOOTING and TV_TESTING (one Samsung/TCL test guide), and contributor docs ARCHITECTURE (now with the integration references), DEVELOPMENT (now with installer packaging) and DESIGN.
  • Removes the internal IMPLEMENTATION.md work log, the old REQUIREMENTS.md backlog and the decision log.
  • README is shorter: what it does, install, quick start, CLI, and grouped guide links. UI labels in the guides were checked against the source strings.

Repo hygiene

  • Preview fixtures write to target/preview/ instead of .localonly/; the manual Samsung TLS test's ignore reason says what it needs.
  • build/ is renamed packaging/ (manifest, icon build helper, cargo-about config).

Verified

  • cargo fmt --check, clippy with -D warnings, tests: 162 lib + 22 app passing.
  • Release build and local MSI/setup packaging; an administrative MSI extract shows LICENSE.txt and THIRD_PARTY_LICENSES.md installed, and the manifest is still embedded after the folder rename.
  • All relative links and anchors in README and docs resolve.
  • Not run: the preview fixtures' new target/preview write path (UI scripts), and a clean-PC install.

Note: two commits picked up staged files from the step after them (the doc deletions sit in the community-files commit, and the folder move sits in the fixtures commit), so 444947a alone doesn't build. The branch as a whole does.

@Xarishark
Xarishark merged commit dcd10d2 into main Nov 8, 2026
2 checks passed
@Xarishark
Xarishark deleted the chore/public-release branch November 8, 2026 15:12
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