Skip to content

Commit

Permalink
[incubator-kie-issues#1395] Add puml explanation to main README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Gabriele-Cardosi committed Jul 23, 2024
1 parent 6eddb73 commit ccc2e48
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,5 +83,15 @@ The following two commands will execute tests on machine with locale different t
1. `make test -Ptest-en`
2. `make test -DTestEn`

Documenting tips
================

UML diagrams have been used for architectural and design documentation. Those diagrams are in ".puml" format and have been created using the [PlantUML](https://plantuml.com/https://plantuml.com/) tool.
Plugins exists to use it in different IDE:
* [IDEA](https://plugins.jetbrains.com/plugin/7017-plantuml-integration)
* [Eclipse](https://marketplace.eclipse.org/content/plantuml-plugin)
* [VisualStudio](https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml)




0 comments on commit ccc2e48

Please sign in to comment.