Skip to content

docs: polish README and remove iCircuit references#40

Open
begeistert wants to merge 1 commit into
masterfrom
docs/readme-polish
Open

docs: polish README and remove iCircuit references#40
begeistert wants to merge 1 commit into
masterfrom
docs/readme-polish

Conversation

@begeistert
Copy link
Copy Markdown
Collaborator

Description

Polishes the README and removes the iCircuit references.

  • Remove iCircuit: drop the iCircuit element (RP2040Elm) — in design roadmap item.
    Generic per-pin GPIO / circuit-simulator support stays (it's a real capability).
  • NuGet badges: add version + downloads badges now that the packages are published;
    make the build badge clickable.
  • Installation: split "Getting Started" into a NuGet Installation section
    (dotnet add package …) and a Building from source section, leading with the
    package install.

Docs-only change; no code touched.

Type of change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 🧹 Refactoring (no functional changes, just code cleanup)

Checklist

  • 🧪 Tests passed locally (dotnet test)
  • ✅ Added new tests for this feature/fix
  • 📝 Documentation updated (if applicable)
  • 🚫 No "Magic Strings" or hardcoded values
  • 💾 Validated against the RP2040 Datasheet (if applicable)

- Add NuGet version/downloads badges (package is now published) and make the
  build badge clickable.
- Split "Getting Started" into NuGet Installation and Building from source, leading
  with `dotnet add package`.
- Remove the iCircuit roadmap item; generic circuit-simulator support stays.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@begeistert begeistert requested a review from lmSeryi as a code owner June 6, 2026 21:56
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