mirror of
https://github.com/ohm-engineering/obsidian-csharp-interactive.git
synced 2026-07-22 07:24:31 +00:00
Update README with requirements and usage details
Added requirements and usage instructions for the plugin.
This commit is contained in:
parent
1118b80ccf
commit
6c6553b41b
1 changed files with 14 additions and 0 deletions
14
README.md
14
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.
|
||||
|
||||
<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
|
||||
|
|
|
|||
Loading…
Reference in a new issue