Skip to content

Update README.md to address NTSC-U and NTSC-J support added in v0.9.0 - #375

Merged
patchzyy merged 4 commits into
patchzyy:mainfrom
NewFireDragon39:main
Oct 29, 2026
Merged

patchzyy merged 4 commits into
patchzyy:mainfrom
NewFireDragon39:main

Conversation

@NewFireDragon39

@NewFireDragon39 NewFireDragon39 commented Oct 28, 2026 •

Copy link
Copy Markdown

The current README.md is outdated. It says only PAL is supported, even though NTSC-U and NTSC-J support was added in v0.9.0. This PR updates the README.md to say it supports PAL, NTSC-U, and NTSC-J.

Summary by CodeRabbit

  • Documentation
    • Updated setup requirements to accept clean, unmodified PAL, NTSC-U, and NTSC-J disc images.
    • Clarified accepted and rejected image formats in the rejection notice, Wheel Wizard and macOS setup instructions, and FAQ.
    • NTSC-K images and modified executables remain explicitly unsupported.

Added NTSC-U and NTSC-J to compatible ISOs. Changed "other regions" to NTSC-K
Fixed typo and installation.
Added NTSC-U and NTSC-J to line 130.
@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Walkthrough

The README now accepts clean PAL, NTSC-U, and NTSC-J disc images in its setup requirements and instructions. It identifies other regions and modified executables as rejected.

Changes: Supported Disc Images

Layer / File(s) Summary
Document supported regions
README.md
The requirements, Wheel Wizard instructions, macOS setup instructions, and FAQ now list clean PAL, NTSC-U, and NTSC-J images. The README identifies other regions and modified executables as rejected.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Suggested reviewers: theofficialgman, patchzyy

Merge Risk: Minimal · up to e4b0c

No concrete installation regression is established by this documentation change. Compatibility of the external Wheel Wizard route with NTSC-U and NTSC-J images remains unconfirmed.

Pre-merge checks: Passed 4
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title names the README update and the NTSC-U and NTSC-J support, which matches the changeset. The raw summary says the README now accepts PAL (RMCP01), NTSC-U (RMCE01), and NTSC-J (RMCJ01) images …
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title names the README update and the NTSC-U and NTSC-J support, which matches the changeset. The raw summary says the README now accepts PAL (RMCP01), NTSC-U (RMCE01), and NTSC-J (RMCJ01) images and rejects NTSC-K and modified executables. The objectives say the PR states PAL, NTSC-U, and NTSC-J are supported, reflecting v0.9.0. The title does not mention PAL or the rejection rules, but it covers the main point. The title is 69 characters and 11 words, which is longer than the short single-sentence form the guidelines prefer. Its wording also ties the change to a past release (v0.9.0), which the README edit reflects. It is not vague and does not describe unrelated work.

Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔇 Additional comments: 1
README.md-120-120: 1

120-120: Minor · Potential issue · Heavy lift

⚠️ Unverified finding
We couldn't verify this from the code. It is shown for review, not as a verified issue.

The Wheel Wizard instructions now invite NTSC-U and NTSC-J images, but the wrapper may retain a PAL-only image filter or invoke setup without preserving the selected region.

The documented easy-install route rejects the image or cannot complete the installation.

This can occur when: A user selects a clean RMCE01 or RMCJ01 image in Wheel Wizard and clicks install.


Review info
Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: bb7f41e4-5919-41f0-b310-aaec78ef34a5
Commits

Reviewing files that changed from the base of the PR and between ae54b6e and e4b0c6b.

Files selected for processing: 1
  • README.md

Included review availability: This review used your included allowance. Your plan provides up to 4 included reviews per hour; 3 remain after this review.

@patchzyy
patchzyy merged commit b748155 into patchzyy: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