Updated docs with Mermaid docs

This commit is contained in:
Bartek Kryza
2023-09-13 18:54:23 +02:00
parent 70e7088823
commit abd85534bc
15 changed files with 137 additions and 35 deletions

View File

@@ -44,8 +44,14 @@ To add an initial class diagram to your project, follow these steps:
```
4. Generate SVG images from the PlantUML diagrams:
```bash
plantuml -tsvg puml/*.puml
plantuml -tsvg diagrams/*.puml
```
or generate also MermaidJS diagram (requires [mermaid-cli](https://github.com/mermaid-js/mermaid-cli)):
```
clang-uml --progress -n some_class_diagram -g mermaid
mmdc -i diagrams/some_class_diagram.mmd -o diagrams/some_class_diagram.svg
```
5. Add another diagram:
```bash
clang-uml --add-sequence-diagram another_diagram