Skip to content

Align README with current toolkit + star CTA - #1

Merged
robfernan merged 1 commit into
mainfrom
cursor/align-readme-toolkit-bbe9
Oct 29, 2026
Merged

robfernan merged 1 commit into
mainfrom
cursor/align-readme-toolkit-bbe9

Conversation

@robfernan

Copy link
Copy Markdown
Owner

Summary

The pinned-repo README now matches what is actually in the tree, and the first screen is the sample screenshots plus a one-line star ask.

  • Hook leads with the C and SDL2 samples (and the small rust-psp crate). The Zig gallery link pointed at psp_projects/zig_cube_psp, which is not in the repo, so that row is gone.
  • Badges no longer say “Official.” The extension badge is “local extension,” and the MCP badge is “in-repo server.” Marketplace publish stays an open roadmap item. A checked-in .vsix is documented as a local install.
  • Screenshot grid keeps every existing PPSSPP capture and adds Hello World, which already had an image. Each tile links to that sample’s tutorial.
  • Star line is a single sentence. No star count or other made-up numbers. The CI badge is the live Actions status for build.yml.
  • Command-line build steps are unchanged (psp-cmake, desktop cmake for the SDL2 samples, make, PPSSPP and Memory Stick deploy paths). Sample READMEs were not edited.
  • Extension and MCP sections describe the handlers that exist: handheld-frame canvas preview, PPSSPP play command, hardware lint, and the PS2-to-PSP checklist. Scaffold and emulator MCP tools are described as status payloads.

Test

  • Every relative link and image path in README.md resolves to a file in the repo.
  • No sample tutorial files were modified.
Open in Web Open in Cursor 

Lead with the C and SDL2 examples, keep the screenshot grid, and describe the in-repo VS Code extension and MCP server without marketplace claims.

Co-authored-by: Robert  <robfernan@users.noreply.github.com>
@robfernan
robfernan merged commit 1105050 into main Oct 29, 2026
1 check passed
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