docs: Ensured Ubuntu (Unix) Compatibility

[0x-ximon]

Summary

Updated README with notes and tips on how to build on Debian/ Ubuntu. Addresses issue: #360

Testing Process

• The repository was cloned to a fresh installation of Ubuntu v24.04.
• Installed build-essential in order to compile the libsodium package.
• Installed the Rust toolchain and Git.
• Cloned the Repository and tried to build.
• Ran into OpenSSL issues but resolved by installing the libssl-dev pkg-config packages.
• Did not encounter any Pre-commit issues as well.

Checklist

• Add a reference to related issues in the PR description.
• Add unit tests if applicable.

Summary by CodeRabbit

• Documentation
  • Expanded README with OS-specific setup notes for Debian/Ubuntu users.
  • After libsodium installation steps, added guidance to install build-essential if missing to ensure required compilation tools are available.
  • After the key-generation example, added a warning to install libssl-dev and pkg-config to prevent OpenSSL-related build errors during installation or builds.

[coderabbitai]

Walkthrough

Updated README.md with two Debian/Ubuntu-specific notes: installing build-essential after libsodium steps, and installing libssl-dev and pkg-config after the key-generation example to prevent OpenSSL-related errors.

Changes

Cohort / File(s)	Summary of edits
Documentation updates README.md	Added notes for Debian/Ubuntu: install build-essential post-libsodium; install libssl-dev and pkg-config after key-generation to avoid OpenSSL errors.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related issues

• Ensure Ubuntu (Unix) Compatibility for Contributors #360 — Adds Ubuntu-specific dependency instructions (build-essential, libssl-dev, pkg-config) aligning with the issue’s setup concerns.

Poem

A nibble of notes in README land,
I twitch my whiskers, docs in hand.
For Ubuntu burrows, tools you’ll need—
OpenSSL won’t trip your speed.
With build-essentials stacked just right,
We hop through installs, light and bright. 🐇✨

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

All contributors have signed the CLA ✍️ ✅
_{Posted by the CLA Assistant Lite bot.}

[0x-ximon]

I confirm that I have read and hereby agree to the OpenZeppelin Contributor License Agreement

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

255-256: Polish Debian/Ubuntu note: fix grammar, remove extra spacing, and use a copy-pastable command block.

Current sentence has casing issues (“On”), extra spaces around the slash, and embeds the apt command inline. Suggest making it concise and consistent with the rest of the README by using a fenced bash block and including apt-get update and -y for smoother UX.

-  > **Note**: To compile On Debian/ Ubuntu, you must install the `build-essential` by running `sudo apt-get install build-essential` if it's missing.
+  > Note (Debian/Ubuntu): If you're compiling libsodium from source, install build-essential first.
+  ```bash
+  sudo apt-get update && sudo apt-get install -y build-essential
+  ```

---

329-330: Update Debian/Ubuntu installation instructions for OpenSSL

To make the OpenSSL hint more visible and consistent (and to reduce friction on fresh installs), switch from the inline command to a fenced bash block that includes apt-get update and the -y flag.

• File: README.md
• Lines: 329–330

- > :warning: On Ubuntu/ Debian, if you encounter OpenSSL errors, install the `libssl-dev` and `pkg-config` packages: `sudo apt-get install libssl-dev pkg-config`
+ > :warning: Debian/Ubuntu: If you encounter OpenSSL build errors, install the required packages:
+ >
+ > ```bash
+ > sudo apt-get update && sudo apt-get install -y pkg-config libssl-dev
+ > ```

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 818258a and ca1e693.

📒 Files selected for processing (1)

• README.md (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: Redirect rules - openzeppelin-relayer
• GitHub Check: Header rules - openzeppelin-relayer
• GitHub Check: Pages changed - openzeppelin-relayer
• GitHub Check: semgrep/ci

[zeljkoX]

Thank you for your contribution and time spent testing!

LGTM!

[tirumerla]

Thank you for your contribution @0x-ximon, Could you please fix the signed commits and PR title. Thanks.

[0x-ximon]

@tirumerla I've updated the PR title. What signed commit are you referring to?

[tirumerla]

@tirumerla I've updated the PR title. What signed commit are you referring to?

Looks like some of the commits are unverified. You will need to rebase commits with signed ammends.

[tirumerla]

@0x-ximon could you also please take care of nits from code rabbit #429 (review). Thanks

[LuisUrrutia]

LGTM. There are some comments from CodeRabbit which are about putting the commands to install build-essentials as markdown code, which is nice, so you should modify the PR to include that.

[0x-ximon]

@tirumerla I recently switched upgraded my Debian OS and switched out GPG keys so that explains the unverified commits. I might have to close this PR and create a new one with all commits verified. What do you think?

[tirumerla]

@tirumerla I recently switched upgraded my Debian OS and switched out GPG keys so that explains the unverified commits. I might have to close this PR and create a new one with all commits verified. What do you think?

Sure sounds good with me