Skip to content

Add comprehensive README#11

Merged
key merged 1 commit intomainfrom
update-readme
Feb 9, 2026
Merged

Add comprehensive README#11
key merged 1 commit intomainfrom
update-readme

Conversation

@key
Copy link
Member

@key key commented Feb 9, 2026

Summary

  • Add full README with project description, tools table, quickstart guides (Docker and source), environment variable configuration reference, MCP client setup examples (Claude Desktop and Claude Code), architecture diagram, development commands, and project structure overview
  • Add CLAUDE.local.md to .gitignore

Test plan

  • Verify README renders correctly on GitHub
  • Verify all links are valid
  • Verify Docker and source build instructions work

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Enhanced README with comprehensive information about the MCP sigrok server, including quickstart instructions, configuration details, architecture overview, development guidelines, and project structure.

- Add project description, tools table, quickstart (Docker + source),
  configuration reference, MCP client setup (Claude Desktop + Claude Code),
  architecture diagram, development guide, and project structure
- Add CLAUDE.local.md to .gitignore

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link

coderabbitai bot commented Feb 9, 2026

Walkthrough

Two documentation and configuration updates: .gitignore expanded to exclude CLAUDE.local.md local settings file, and README.md substantially enhanced with comprehensive MCP sigrok server documentation covering tools, quickstart, configuration, and architecture.

Changes

Cohort / File(s) Summary
Configuration & Documentation
.gitignore, README.md
Added local settings file to gitignore; expanded README with full project documentation including overview, tools, quickstart, configuration, and architecture details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A doc so grand, we weave and write,
In README's light, the project shines bright!
Local files tucked away from sight,
Organization done just right! ✨


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

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

@key key merged commit 2261989 into main Feb 9, 2026
5 checks passed
@key key deleted the update-readme branch February 9, 2026 07:47
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