Skip to content

Latest commit

 

History

History
31 lines (24 loc) · 927 Bytes

README.adoc

File metadata and controls

31 lines (24 loc) · 927 Bytes

About the ModelBank Architecture Documentation

How to Build

  • check if you have jq, plantuml and asiidoctor installed

    $ make check

  • install if needed

    $ brew install plantuml jq
$ gem install asciidoctor

  • create architecture documentation

    $ make docs/arc42/modelbank-arc42.html

Tools Used for Diagrams

We use PlantUML for simple diagrams. This allow us to put the plain text diagram sources under source control. PlantUML diagrams are put into the diagrams folder and are named *.puml. At build time we generate PNGs from them and put them in the ignored folder images/generated.

More complex diagrams (like the diagram in Deployment View) are created with https://draw.io, which is now completely free and even offers a desktop app. draw.io diagrams are saved as XML, also put in the images folder.