From ccc2e4863ff62c316df652172d66ef4bdc539b78 Mon Sep 17 00:00:00 2001 From: Gabriele-Cardosi Date: Tue, 23 Jul 2024 11:49:10 +0200 Subject: [PATCH] [incubator-kie-issues#1395] Add puml explanation to main README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 161caebddd8..00110beaeda 100644 --- a/README.md +++ b/README.md @@ -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) + +