Skip to content

Commit 7c24fa5

Browse files
committed
Organize tests into src/tests/ and update README packaging guide
- Moved DevDecoder.GpioSimulator.Tests and DevDecoder.GpioSimulator.OfficialTests into src/tests/ - Updated GpioSimulator.slnx and relative project references to match the new structure - Clarified in README that users should install either DevDecoder.GpioSimulator or DevDecoder.GpioSimulator.Drivers, and that Common is transitively included
1 parent d144623 commit 7c24fa5

6 files changed

Lines changed: 12 additions & 6 deletions

File tree

GpioSimulator.slnx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@
33
<Project Path="src/DevDecoder.GpioSimulator.Common/DevDecoder.GpioSimulator.Common.csproj" />
44
<Project Path="src/DevDecoder.GpioSimulator.Drivers/DevDecoder.GpioSimulator.Drivers.csproj" />
55
<Project Path="src/DevDecoder.GpioSimulator.Sample/DevDecoder.GpioSimulator.Sample.csproj" />
6-
<Project Path="src/DevDecoder.GpioSimulator.Tests/DevDecoder.GpioSimulator.Tests.csproj" />
76
<Project Path="src/DevDecoder.GpioSimulator.Web/DevDecoder.GpioSimulator.Web.csproj" />
87
<Project Path="src/System.Device.Gpio/System.Device.Gpio.csproj" />
9-
<Project Path="src/DevDecoder.GpioSimulator.OfficialTests/DevDecoder.GpioSimulator.OfficialTests.csproj" />
8+
</Folder>
9+
<Folder Name="/tests/">
10+
<Project Path="src/tests/DevDecoder.GpioSimulator.Tests/DevDecoder.GpioSimulator.Tests.csproj" />
11+
<Project Path="src/tests/DevDecoder.GpioSimulator.OfficialTests/DevDecoder.GpioSimulator.OfficialTests.csproj" />
1012
</Folder>
1113
</Solution>

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ An extensible, drop-in C# NuGet replacement library for `System.Device.Gpio` tha
2020

2121
## 📦 The Packages & Target Scenarios
2222

23-
The simulator is modularly split into **three NuGet packages** depending on your usage scenario:
23+
The simulator is modularly split into **three NuGet packages** depending on your usage scenario.
24+
25+
> [!IMPORTANT]
26+
> In most target scenarios, you should **only install either** `DevDecoder.GpioSimulator` (Scenario A) **OR** `DevDecoder.GpioSimulator.Drivers` (Scenario B). You **do not** need to explicitly install `DevDecoder.GpioSimulator.Common` as it is automatically pulled in as a dependency by the other packages.
2427
2528
### 1. `DevDecoder.GpioSimulator` (Drop-in Web & Visual Shim)
2629
* **What it is:** The complete drop-in replacement library that replaces the standard `System.Device.Gpio` namespace.
@@ -42,7 +45,7 @@ The simulator is modularly split into **three NuGet packages** depending on your
4245

4346
### 3. `DevDecoder.GpioSimulator.Common` (Shared State Simulation Engine)
4447
* **What it is:** The pure class library containing the thread-safe state containers, logical-to-physical conversions, and owner tracking.
45-
* **When to use:** Used under the hood by both of the packages above. You can also use it to implement your own custom GPIO driver/mock entirely decoupled from presentation or transportation details.
48+
* **When to use:** Used under the hood by both of the packages above. You **do not need to install this package directly**, as it is transitively included by both the shim and drivers packages. You only need to explicitly install this if you are building your own completely independent custom GPIO drivers or presentation layers decoupled from our visual simulator.
4649
* **Installation:**
4750
```bash
4851
dotnet add package DevDecoder.GpioSimulator.Common --version 0.5.0-beta

src/DevDecoder.GpioSimulator.OfficialTests/DevDecoder.GpioSimulator.OfficialTests.csproj renamed to src/tests/DevDecoder.GpioSimulator.OfficialTests/DevDecoder.GpioSimulator.OfficialTests.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
</ItemGroup>
2626

2727
<ItemGroup>
28-
<ProjectReference Include="..\DevDecoder.GpioSimulator.Drivers\DevDecoder.GpioSimulator.Drivers.csproj" />
28+
<ProjectReference Include="..\..\DevDecoder.GpioSimulator.Drivers\DevDecoder.GpioSimulator.Drivers.csproj" />
2929
</ItemGroup>
3030

3131
<ItemGroup>

src/DevDecoder.GpioSimulator.Tests/DevDecoder.GpioSimulator.Tests.csproj renamed to src/tests/DevDecoder.GpioSimulator.Tests/DevDecoder.GpioSimulator.Tests.csproj

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@
2020
</ItemGroup>
2121

2222
<ItemGroup>
23-
<ProjectReference Include="..\System.Device.Gpio\System.Device.Gpio.csproj" />
23+
<ProjectReference Include="..\..\System.Device.Gpio\System.Device.Gpio.csproj" />
24+
<ProjectReference Include="..\..\DevDecoder.GpioSimulator.Common\DevDecoder.GpioSimulator.Common.csproj" />
2425
</ItemGroup>
2526

2627
<ItemGroup>

src/DevDecoder.GpioSimulator.Tests/GpioControllerTests.cs renamed to src/tests/DevDecoder.GpioSimulator.Tests/GpioControllerTests.cs

File renamed without changes.

src/DevDecoder.GpioSimulator.Tests/PinValueTests.cs renamed to src/tests/DevDecoder.GpioSimulator.Tests/PinValueTests.cs

File renamed without changes.

0 commit comments

Comments
 (0)