Files
cleanyourtv/docs/workflows/showcase.md
T
xbsheng 4dcb4296ed SHOWCASE: two rows the brand index never linked, and the generic line in the recipe
The MiTV4-ANSM0 launcher (qqwersde's tree, the same board as the Xmen Android 6 port that is on the
Xiaomi line) and the phone app 'Clean Your TV app' were both written into SHOWCASE.md's tables and never
into 'Find a project by TV brand', so a reader looking their own set up by brand missed them.

The recipe said only 'under its TV brand', which leaves a project with no single brand nowhere to go;
step 1 now names the 'Any Android TV (emulator or generic)' line for those. tests/test_showcase_brand_index.py
grows the check that every table row is reachable from the index (exempting the two rows whose TV cell
names no brand, each with its reason and a test that keeps the exemption honest), and the recipe test
that step 1 names the generic line.
2026-10-25 10:15:56 +08:00

1.1 KiB

Workflow: Add a showcase row

When to use this: a project built on this repo that lives in its own repository.

  1. Add one row to the section of SHOWCASE.md that fits (home screens, forks, screensavers and add-ons, tools, other platforms), and the project under its TV brand in "Find a project by TV brand" - or under "Any Android TV (emulator or generic)" when it names no single brand, as the phone apps do.
  2. Bump the two counts by one: SHOWCASE.md opens with an N projects so far. line, and the "Built something on top?" row in README.md spells the same number in words. tests/test_showcase_project_count.py refuses a row that leaves either of them behind.
  3. Keep each cell to one line: what it is, what it was built and tested on, and the author.
  4. The project is open source with a link people can read and build, says which TV it was tested on, collects nothing beyond what its README says, and is yours or listed with the author's blessing.
  5. Put a screenshot in the PR description; it is linked from the row.

Then run the tests: python3 -m unittest discover -s tests -v.