From 639fb754463ebe725c1803d051a43e98aebd31b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Montiel=20Cardona?= Date: Sat, 6 Jun 2026 15:56:18 -0600 Subject: [PATCH] docs: polish README and drop iCircuit references - 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 --- README.md | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d3b951a..850e6a5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # RP2040Sharp -![Build Status](https://github.com/PyMCU/RP2040Sharp/actions/workflows/test.yml/badge.svg) +[![Build Status](https://github.com/PyMCU/RP2040Sharp/actions/workflows/test.yml/badge.svg)](https://github.com/PyMCU/RP2040Sharp/actions/workflows/test.yml) +[![NuGet](https://img.shields.io/nuget/v/RP2040Sharp.svg)](https://www.nuget.org/packages/RP2040Sharp) +[![Downloads](https://img.shields.io/nuget/dt/RP2040Sharp.svg)](https://www.nuget.org/packages/RP2040Sharp) ![License](https://img.shields.io/badge/license-MIT-blue.svg) ![.NET Version](https://img.shields.io/badge/.NET-10.0-purple) @@ -32,13 +34,22 @@ The emulator boots MicroPython v1.21.0 and reaches the interactive REPL in appro - **Per-pin GPIO API** (`SetGpioExternalIn`, `GetGpioOutputEnable`, `GetGpioOut`) for embedding in circuit simulators - **TestKit** fluent API for writing firmware integration tests -## Getting Started +## Installation + +```bash +dotnet add package RP2040Sharp # the emulator +dotnet add package RP2040Sharp.TestKit # fluent harness for firmware tests +``` + +Requires the .NET 10 SDK. + +## Building from source ```bash git clone https://github.com/PyMCU/RP2040Sharp.git cd RP2040Sharp -dotnet restore dotnet build +dotnet test ``` **Run the demo** (downloads MicroPython, boots it, executes REPL snippets, reports MIPS): @@ -47,12 +58,6 @@ dotnet build dotnet run --project src/RP2040Sharp.Demo -c Release ``` -**Run the tests:** - -```bash -dotnet test -``` - ## Basic Usage ```csharp @@ -185,7 +190,6 @@ server.Start(); - [x] Real RP2040 B1 BootROM (embedded resource) - [x] MicroPython v1.21.0 boots to REPL - [x] Per-pin GPIO API for circuit simulator embedding -- [ ] iCircuit element (`RP2040Elm`) — in design - [ ] NativeAOT targets (Windows, Linux, macOS, iOS) - [ ] WebAssembly (WASM) target