Skip to content

Commit d39111a

Browse files
committed
Add a legend
1 parent 0994799 commit d39111a

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ model inspired by [behaviour-oriented concurrency](https://doi.org/10.1145/36228
77
To this end, FrankenScript programs generate a file called `mermaid.md` with a Mermaid diagram per line in the source program showing the object and region
88
graph of the program at that program point.
99

10+
This is a legend for the diagrams that FrankenScript generates:
11+
12+
![](./docs/frankenscript-legend.png)
13+
1014
## Pre-requisites
1115

1216
This project is C++20 based and uses CMake as the build system. We also recommend installing Ninja to speed up the build process.
@@ -49,3 +53,4 @@ You can run in interactive mode by running:
4953
```
5054

5155
Which will keep overwritting the `mermaid.md` file with the new heap state after each step.
56+

docs/frankenscript-legend.png

292 KB
Loading

0 commit comments

Comments
 (0)