diff --git a/README.md b/README.md index 2977fd35395e13a44037bb1246454edf46fc2102..65d701bdb9e550ca47c0c90d2498789eadf51a90 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # puml includes Utility project to include some common PlantUML files, that are used in the UML diagrams of the project -They have to be publicly available somewhere due that the "!include" directive of PlantUML doesn't work in Gitlab (see https://gitlab.com/gitlab-org/gitlab/-/issues/28847) \ No newline at end of file + +They have to be publicly available somewhere due that the "!include" directive of PlantUML doesn't work in Gitlab (see https://gitlab.com/gitlab-org/gitlab/-/issues/28847) + +The UML files of EMERALD typically include several common files to define common graphical elements (arrows, colors, names, etc.). For example: + +```plantuml + +@startuml RCM Sequence Diagram +!include ../roles.wsd + +[..] + +@enduml +``` \ No newline at end of file