Skip to content

Add Linux prerequisites documentation (#8)#15

Merged
Liohtml merged 1 commit into
masterfrom
claude/linux-prereqs-docs
Jun 24, 2026
Merged

Add Linux prerequisites documentation (#8)#15
Liohtml merged 1 commit into
masterfrom
claude/linux-prereqs-docs

Conversation

@Liohtml

@Liohtml Liohtml commented Jun 24, 2026

Copy link
Copy Markdown
Owner

Description

Critical documentation: Linux prerequisites for building and running the bridge.

Changes

Without these prerequisites, users encounter non-obvious build failures (linker cc not found, libudev-sys build fails, permission denied on /dev/ttyUSB0). This section prevents frustration on first-time setup.

Type of Change

  • Documentation update

Component

  • Bridge (HTTP server, session collection)
  • Serial Bridge (USB transport binary)

Testing

  • Documentation only; no code changes.

Closes #8

🤖 Generated with Claude Code


Generated by Claude Code

Add "Linux prerequisites" section to README documenting required system
packages for building and running the bridge on Linux/WSL2:
- build-essential, pkg-config, libudev-dev (for serialport crate)
- dialout group membership for USB serial access without sudo

Includes clear post-installation step (log out/in or wsl --shutdown for WSL).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01NbHMpmG4SriZqFfsVXvW53
@coderabbitai

coderabbitai Bot commented Jun 24, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@Liohtml, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 54 minutes and 55 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 1f30c19e-534d-441f-80d9-6271968b190c

📥 Commits

Reviewing files that changed from the base of the PR and between 72fbfd6 and 03e78f2.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/linux-prereqs-docs

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.

@github-actions github-actions Bot added the docs label Jun 24, 2026
@Liohtml Liohtml merged commit 33d0beb into master Jun 24, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: list Linux prerequisites (build-essential, pkg-config, libudev-dev, dialout group)

2 participants