Update README with requirements and usage details

Added requirements and usage instructions for the plugin.
This commit is contained in:
Ivan 2026-06-01 16:21:34 +02:00 committed by GitHub
parent 1118b80ccf
commit 6c6553b41b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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.
<img width="960" height="487" alt="Schermafbeelding 2026-05-29 110157" src="https://github.com/user-attachments/assets/233e5535-0cf4-4c75-ba27-8af9a36315ec" />
## 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