Merge branch 'main' of ssh://gitea.apps.sustainabledelivery.com:3022/mostalive/ai-code-exploration
This commit is contained in:
@@ -13,3 +13,6 @@ obj/
|
||||
.dotnet/
|
||||
.local/
|
||||
Library/
|
||||
|
||||
## Javascript
|
||||
.node_modules
|
||||
@@ -0,0 +1,6 @@
|
||||
# Purpose
|
||||
This is a C# exercise repository to explore creating class and sequence diagrams with mermaid, in order to understand an unfamiliar codebase, perform continuous architecture review, or review code generated by coding agents.
|
||||
|
||||
# Generating mermaid diagrams and reviewing syntax
|
||||
|
||||
On linux and mac, the `mmdc` executable is available to create svg diagrams and check syntax. On windows, use the mmdc binary in `./node_modules/bin/mmdc` .
|
||||
@@ -22,6 +22,11 @@ A small C# application for practicing code exploration with a coding agent: use
|
||||
```
|
||||
dotnet build
|
||||
```
|
||||
4. On windows: npm install @mermaid-js/mermaid-cli (global install failed)
|
||||
5. Verify mermaid runs
|
||||
```
|
||||
./node-modules/.bin/mmdc
|
||||
```
|
||||
|
||||
## Tasks
|
||||
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
{
|
||||
"devDependencies": {
|
||||
"@mermaid-js/mermaid-cli": "^11.17.0"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user