Skip to content

docs: describe Marquee in the README and move the user guide to docs/guide.md - #2

Open
Likemiens wants to merge 3 commits into
creator-editionfrom
claude/marquee-project-docs
Open

Likemiens wants to merge 3 commits into
creator-editionfrom
claude/marquee-project-docs

Conversation

@Likemiens

@Likemiens Likemiens commented Nov 4, 2026 •

Copy link
Copy Markdown
Owner

Summary

  • README.md follows the project-docs structure: about, now, results, metrics, how it works, materials, for new contributors, open questions, for developers. It presents the product as Marquee and says the app still ships as OpenScreen until the rename lands.
  • The long user guide (quick clips, Studio, transcripts, full install steps, platform differences, official links, community) moves verbatim to docs/guide.md, with image and link paths adjusted.
  • Short Windows, macOS and Linux install notes stay in the README, because the website links to README#macos.
  • Metrics: live badges for stars and release downloads, the PRD pilot targets, and a note that the website runs no analytics.

Merge notes

  • feat: rename the app to Marquee #3 (the rename to Marquee) doesn't touch README.md and merges cleanly with this branch.

  • The 1.10.0 work on feedback-fixes (no pull request yet) changes two README lines: quick-clip saving and the clip track. Merging it after this PR conflicts in README.md. To resolve, keep this branch's README.md and apply the same two lines to docs/guide.md, where that text now lives.

  • Once a release ships with feat: rename the app to Marquee #3, update the names in the README install notes and in docs/guide.md:

    • Marquee-<version>-Setup.exe;
    • Marquee-Mac-arm64-<version>.dmg / Marquee-Mac-x64-<version>.dmg and /Applications/Marquee.app;
    • Marquee-Linux-<version>.AppImage / .deb / .pacman;
    • default clips folder Videos\Marquee (an existing Videos\OpenScreen stays the default).

    Then drop the "still says OpenScreen" note at the top of both files.

  • Once this PR and feat: rename the app to Marquee #3 are both merged, nothing uses public/openscreen.png any more (feat: rename the app to Marquee #3 keeps it only for the old README), so it can be deleted.

  • Issues are turned off in this repository, but the website links to /issues. This is listed under Open questions.

Checks

  • Every relative link and anchor in README.md and docs/guide.md resolves (scripted check).
  • Every line of the old README is either in README.md or docs/guide.md, or condensed into About and Materials: the callouts, badges and license text.
  • LF line endings.
  • git merge-tree: clean with feat: rename the app to Marquee #3; with feedback-fixes, a conflict in README.md only.

🤖 Generated with Claude Code

…guide.md

The README now follows the project-docs structure (about, now, results,
metrics, how it works, materials, for new contributors, open questions,
for developers) and presents the product as Marquee, with a note that the
app still ships as OpenScreen until the rename lands.

The long user guide (quick clips, Studio, transcripts, full install steps,
platform differences, official links, community) moves verbatim to
docs/guide.md, with image and link paths adjusted. Short Windows, macOS and
Linux install notes stay in the README, because the website links to
README#macos.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
marquee Error Error Nov 4, 2026 4:29pm UTC

Likemiens added a commit that referenced this pull request Nov 4, 2026
The README is rewritten for Marquee in #2; editing the old one here would
only conflict with it. The lockup images were there just for that header.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Likemiens Likemiens mentioned this pull request Nov 4, 2026
6 tasks done
Likemiens and others added 2 commits November 4, 2026 17:36
The rename (#3) keeps the old data folder, so upgrades keep their settings; only the Yandex Disk token has to be pasted again on macOS and Linux. The installers take the Marquee name there, so the open question is now only about the repository.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
PR #3 now sits directly on creator-edition and carries only the rename to Marquee, so the README no longer says it brings 1.10.0.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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