diff options
| author | Emīls <emils@mullvad.net> | 2022-04-28 19:28:27 +0100 |
|---|---|---|
| committer | Emīls <emils@mullvad.net> | 2022-05-31 15:14:14 +0100 |
| commit | 3c1d2fcbcdbbf6414ffb8dee1283b9e883aef8ce (patch) | |
| tree | efd68ff5ac573c4185c0abcf8b3b4c1f325881e7 /docs/diagrams/readme.md | |
| parent | 083d294309978a8cb96a4afc8abc0b4854289213 (diff) | |
| download | mullvadvpn-3c1d2fcbcdbbf6414ffb8dee1283b9e883aef8ce.tar.xz mullvadvpn-3c1d2fcbcdbbf6414ffb8dee1283b9e883aef8ce.zip | |
Improve architecture documentation
Diffstat (limited to 'docs/diagrams/readme.md')
| -rw-r--r-- | docs/diagrams/readme.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/diagrams/readme.md b/docs/diagrams/readme.md new file mode 100644 index 0000000000..50441c46d0 --- /dev/null +++ b/docs/diagrams/readme.md @@ -0,0 +1,6 @@ +# Diagrams +The diagrams are written for [PlantUML](https://plantuml.com/). The SVG files can be produced via `plantuml -tsvg *.puml`. + +The more complex diagrams require a version of PlantUML that uses [eclipses diagramming library](https://plantuml.com/elk), +this is indicated by the line `!pragma layout elk`. + |