From 6c6553b41bf941912979f2ad588883202dd90c84 Mon Sep 17 00:00:00 2001 From: Ivan <43139773+ivanmolenaar@users.noreply.github.com> Date: Mon, 1 Jun 2026 16:21:34 +0200 Subject: [PATCH] Update README with requirements and usage details Added requirements and usage instructions for the plugin. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 8d7f0f9..f6eb0ae 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ Obsidian plugin that adds a run button to C# code blocks. It uses CSharpRepl to execute the snippets and displays the output directly in the note. +Schermafbeelding 2026-05-29 110157 + + ## Features - Supports code blocks containing C# code with tags `csharp`, `cs`, `c#`, `net`, `.net` and `dotnet` @@ -11,6 +14,17 @@ Obsidian plugin that adds a run button to C# code blocks. It uses CSharpRepl to - Saves output and arguments per snippet in the plugin `responses` folder - Restores saved output/arguments when notes are rendered +## Requirements +- Obsidian version >= 1.12.7 +- [dotnet SDK](https://dotnet.microsoft.com/en-us/download) installed on your PC + +## Usage +- Add a code snippet to your Obsidian note with one of these tags: `csharp`, `cs`, `c#`, `net`, `.net` or `dotnet` +- Optionally enter args +- Click `Run C#` + +See [CSharpRepl](https://github.com/waf/CSharpRepl) on how to use with includes and nuget packages + ## Development ```bash