docs: clarify PFS/PFSC image and container workflows in README

[RenanGBarreto]

Summary

This PR improves the PFS-related documentation in README.md.

What changed

• Clarifies the difference between direct PFS images (.ffpfs) and PFSC nested-image containers (.ffpfsc)
• Improves the support table wording for both formats
• Clarifies that pfs_image.dat is treated as a nested PFS image only when located inside a mounted PFSC container
• Cleans up wording in the compressed PFS sections, including a small grammar fixes

Why

The previous README text made the direct PFS and PFSC container flows easy to confuse, especially in the packing examples. These updates make the intended layouts and usage clearer and align the docs with the current implementation.

Scope

Documentation only. No code behavior changes.

Summary by CodeRabbit

• Documentation
  • Updated docs with experimental compressed-PFS image support and streamlined intro text.
  • Expanded supported image table to clearly list .ffpfs (direct) and .ffpfsc (nested-container) options.
  • Clarified container layout and mounting rules for nested vs outer images, and signature/cache behavior.
  • Rewrote packing guidance with recommended exFAT -> .ffpfsc workflow and an alternate folder->image packing option.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 678543d4-8279-4e40-aac6-f3211d2a1bb8

📥 Commits

Reviewing files that changed from the base of the PR and between 2bd8b75 and 53e266d.

📒 Files selected for processing (1)

• README.md

🚧 Files skipped from review as they are similar to previous changes (1)

• README.md

---

📝 Walkthrough

Walkthrough

This PR revises the README to consolidate the intro, clarify support for experimental compressed PFS formats .ffpfs and .ffpfsc, explain nested-container behavior, and add mkpfs-based packing workflows for exFAT→.ffpfsc, folder→pfs_image.dat→.ffpfsc, and experimental .ffpfs one-pass packing.

Changes

Compressed PFS Format Documentation

Layer / File(s)	Summary
Format support and recommendation README.md	Consolidates the README intro; updates the “Current image support” table with clarified .ffpfs and .ffpfsc rows; adds guidance recommending experimentation with .ffpfsc and preferring nested exFAT layout.
PFSC container behavior & packing workflows README.md	Clarifies when a nested pfs_image.dat is treated as a PFS image inside .ffpfsc and how outer vs inner img_type apply; replaces compressed-PFS packing docs with mkpfs exFAT→.ffpfsc commands, adds folder→pfs_image.dat→.ffpfsc workflow, and documents experimental direct .ffpfs one-pass packing example.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Poem

🐰 I hopped through lines of README prose,

New formats named where the compressed wind blows.
exFAT nests snug in .ffpfsc's care,
mkpfs packs tidy in a single dare.
Docs refreshed — the rabbit gives a cheer!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and concisely summarizes the main change: clarifying PFS/PFSC image and container workflows in README documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[Copilot]

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Updates the README to clarify ShadowMountPlus image-type semantics and to expand/modernize documentation around compressed PFS workflows (especially .ffpfsc and .ffpfs).

Changes:

• Refines the “Current image support” table descriptions for .ffpfs / .ffpfsc.
• Reworks the “Compressed PFS” docs to focus on recommended exFAT→PFSC packing and adds new .ffpfs (direct) guidance.
• Adjusts wording around PFSC container layout requirements and headings.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.