From d083b1b40d5baa6e2dccec3386bc54dbf764dc2c Mon Sep 17 00:00:00 2001 From: Mark Nolan Date: Mon, 21 Sep 2026 10:23:49 +0100 Subject: [PATCH] Add AGENTS.md for coding agents, with a CLAUDE.md bridge AGENTS.md is the vendor-neutral convention for agent instructions, read directly by Cursor, Copilot, Codex and others. It routes to the existing README and developer docs rather than restating them, and records the constraints that are not discoverable from the code alone. Claude Code can read AGENTS.md directly on recent versions, but only when no CLAUDE.md is present, and not at all on older versions or third-party providers. The one-line CLAUDE.md import makes it reach every session either way. Co-Authored-By: Claude Opus 5 --- AGENTS.md | 35 +++++++++++++++++++++++++++++++++++ CLAUDE.md | 18 ++++++++++++++++++ 2 files changed, 53 insertions(+) create mode 100644 AGENTS.md create mode 100644 CLAUDE.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..a57343f --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,35 @@ +# Shimmer-Labview-API + +LabVIEW support for Shimmer devices. **This repo is mid-migration**, and that shapes almost every +decision in it. + +## The migration + +LabVIEW support is moving onto a **new wrapper built over the core C# API** (`Shimmer-C-API`). The +old LabVIEW API is being retired and existing users have to migrate onto the wrapper. + +The stated reason, from `Readme.md`: the C# API is widely used across research, industry and Shimmer's +own internal tools, so it is the most heavily developed and tested. Aligning LabVIEW to it gives +consistent behaviour and faster fixes rather than a second parallel implementation to maintain. + +**The practical consequence:** this is a wrapper, not an implementation. A parsing, protocol, +calibration or timestamp fix belongs in `Shimmer-C-API` — fix it there and it reaches LabVIEW users +through the bridge. Reimplementing that logic here would recreate exactly the divergence the +migration exists to remove. + +``` +ShimmerLabviewC#Wrapper/ ShimmerBridge.cs, ShimmerLVWrapper.sln/.csproj — the C# bridge +ShimmerLabview/ Bin/, Examples/ — the LabVIEW side +``` + +The wrapper uses `packages.config`-style NuGet, so restore behaves differently from the +`PackageReference` projects elsewhere in `C:\dev\csharp\`. + +## Before changing anything here + +Check whether the change belongs in `Shimmer-C-API` instead. If it does, make it there; if it is +genuinely bridge-specific — marshalling, LabVIEW type mapping, the VI surface — it belongs here. +Say which you concluded and why, because the answer is not obvious from inside this repo. + +Anything documenting the *old* LabVIEW API is being retired: prefer updating the wrapper's story over +extending the legacy one. diff --git a/CLAUDE.md b/CLAUDE.md new file mode 100644 index 0000000..5febe66 --- /dev/null +++ b/CLAUDE.md @@ -0,0 +1,18 @@ +@AGENTS.md + +