Skip to content

Show the 30-second promo near the top of the README - #8

Open
Lexus2016 wants to merge 1 commit into
mainfrom
cursor/readme-promo-video-5334
Open

Lexus2016 wants to merge 1 commit into
mainfrom
cursor/readme-promo-video-5334

Conversation

@Lexus2016

Copy link
Copy Markdown
Owner

Summary

Adds the 30-second promo (9:16, English voiceover and subtitles) so it shows up right after the title, badges, and intro, before the install sections.

GitHub does not play a repository mp4 inside a README, so each README uses a clickable poster (300px wide) that links to the mp4 on GitHub, with a short caption.

  • assets/turbo-quant-memory-promo.mp4
  • assets/turbo-quant-memory-poster.jpg — a frame of the memory tools in the terminal; kept as the poster because it shows the product more clearly than the title cards

README.md is the PyPI long description, so its poster and link are absolute (raw.githubusercontent.com for the image, github.com/.../blob/main/... for the mp4). A relative image there is what left a blank hero on PyPI in 0.28.2. README.uk.md and README.ru.md keep relative paths, the same way their heroes do, and those are the paths GitHub rewrites when it renders the file (raw for the image, blob for the mp4).

The mp4 is excluded from the sdist (/assets/*.mp4). The poster JPEG stays with the other README assets. Confirmed with a local hatchling build -t sdist: the archive contains the poster and not the mp4.

Test plan

  • On the branch, open README.uk.md and README.ru.md and confirm the poster renders at about 300px wide and both the image and the caption open assets/turbo-quant-memory-promo.mp4 in GitHub's player
  • After merge, confirm the same on README.md (the absolute main URLs 404 until the files are on main)
Open in Web Open in Cursor 

GitHub does not play a committed mp4 inside the README, so the poster
links to the file. The English README uses absolute URLs because it is
the PyPI long description. The mp4 stays out of the sdist.

Co-authored-by: Lexus2016 <Lexus2016@users.noreply.github.com>
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review 🔄 Running since 2026-10-22T21:57:47.206718Z 45a17dd PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

This branch has not been deployed

No deployments
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.

2 participants