Skip to content

Add AGENTS.md with Cursor Cloud development instructions #128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
danipen wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Add AGENTS.md with Cursor Cloud development instructions #128

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# AGENTS.md

## Cursor Cloud specific instructions

This is a .NET class library project (TextMateSharp) — no external services, databases, or Docker required.

### Prerequisites
- .NET 8.0 SDK (test/demo/benchmark projects target `net8.0`; core libraries target `netstandard2.0`)

### Key commands
| Action | Command | Notes |
|---|---|---|
| Restore | `dotnet restore` | From repo root |
| Build | `dotnet build` | Builds all 6 projects in `TextMateSharp.sln` |
| Test | `dotnet test` | Runs NUnit tests in `TextMateSharp.Tests` and `TextMateSharp.Grammars.Tests` (726 tests) |
| Demo | `cd src/TextMateSharp.Demo && dotnet run -- ./testdata/samplefiles/sample.cs` | Syntax-highlights a sample C# file |
| Benchmark | `cd src/TextMateSharp.Benchmarks && dotnet run -c Release` | BenchmarkDotNet performance tests |

### Non-obvious notes
- The CI workflow (`.github/workflows/dotnet.yml`) installs .NET 6.0.x, but `net8.0` is the actual TFM for test/demo/benchmark projects. You need .NET 8.0 SDK.
- The `Onigwrap` native library version is pinned in `build/Directory.Build.props`. If builds fail with native-interop errors, check that file.
- No linter is configured (no `.editorconfig` enforcement, no `dotnet format` CI step). Code style is not enforced via tooling.
- Sample test data files for the demo app are in `src/TextMateSharp.Demo/testdata/samplefiles/`.
Loading