Skip to content

docs: update README install steps (xcbeautify and init submodules)#44

Open
Rezisn wants to merge 2 commits into
mobile-next:mainfrom
Rezisn:docs/update-readme-docs
Open

docs: update README install steps (xcbeautify and init submodules)#44
Rezisn wants to merge 2 commits into
mobile-next:mainfrom
Rezisn:docs/update-readme-docs

Conversation

@Rezisn
Copy link
Copy Markdown

@Rezisn Rezisn commented May 8, 2026

Summary

  • Clarify xcbeautify as a required dependency for building devicekit-ios.
  • Ensure git submodules are initialized during setup (required for Opus).
  • Updated Quick Start step to include parameters for device.screenshot.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 8, 2026

Walkthrough

The README documentation has been updated in two areas. The "Building from Source" section now includes explicit instructions to install the xcbeautify dependency via Homebrew and to initialize git submodules using git submodule update --init --recursive. In the "Quick Start" section, the example JSON-RPC request for device.screenshot was modified to pass format: "jpg" as a parameter instead of using an empty parameters object, with corresponding adjustments to the curl command output formatting.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main changes: updating README documentation with xcbeautify dependency and git submodule initialization instructions.
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.
Description check ✅ Passed The pull request description directly aligns with the changeset, clearly documenting the three main updates: clarifying xcbeautify as a dependency, adding git submodule initialization, and updating the device.screenshot example.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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 and usage tips.

@Rezisn Rezisn changed the title docs: update README install steps (xcbeautif and init submodules) docs: update README install steps (xcbeautify and init submodules) May 8, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Around line 83-86: The description for the device.screenshot example is
inconsistent: the JSON-RPC call sets "format": "jpg" but the text says it
returns a PNG; update the README so they match by either changing the params in
the example (the JSON string for method "device.screenshot" and params "format")
to "png" or change the descriptive sentence to state it returns a base64-encoded
JPEG; ensure references to "device.screenshot" and the "format" param are
updated accordingly.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b096ac97-f8d4-41ce-a068-45e5ba36bbc0

📥 Commits

Reviewing files that changed from the base of the PR and between 9562f3a and b5cf1ef.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md Outdated
Comment thread README.md
curl -X POST http://127.0.0.1:12004/rpc \
-H "Content-Type: application/json" \
-d '{"jsonrpc":"2.0","method":"device.screenshot","params":{},"id":1}'
-d '{"jsonrpc":"2.0","method":"device.screenshot","params":{ "format": "png" },"id":1}'
Copy link
Copy Markdown
Author

@Rezisn Rezisn May 8, 2026

Choose a reason for hiding this comment

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

found that current implementation of device.screenshot (here) set format as mandatory parameters.

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