diff --git a/README.md b/README.md index 0e59de65f..b59cd198c 100755 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ - [Backend services](#backend-services) - [Testing](#testing) - [Checking the build](#checking-the-build) +- [Produce UML documentation with Android Studio](#produce-uml-documentation-with-android-studio) - [Contributing](#contributing) - [Contributors](#contributors) - [License](#license) @@ -147,6 +148,27 @@ In addition to making the code open-source, we wish to help people verify that b Currently, we have a working open continuous integration for building the client. [Here](.circleci/config.yml) is the full specification. When it comes to reproducible builds, we will instead open an issue explaining what we have done so far and any missing steps. +# Produce UML documentation with Android Studio + +To create a UML class diagram of immuni app with Android Studio you can use a plugin like this +https://plugins.jetbrains.com/plugin/4946-simpleumlce/reviews +I's work well and it's free. + +I need to install plugin of Android Studio +![install plugin](doc_images/screen_simpleUML_install.png) + + +Then it will be enabled a TAB on left page with some buttons: load, save, and overview also other buttons +to manage the diagram layout to make it more detailed. +![tab plugin](doc_images/screen_tab_simpleUML.png) + +If press right button on project folder \ namespace the tool make the diagram only for this specific namespace, it will open +a menu with at the bottom this item "Add to simpleUML Diagram" like this +![pop up menu plugin](doc_images/screen_tasto_dx_su_namespace.png) + +The it's possible save the diagram in img format trought a dialog by decide where save the file like this +![save pop-up](doc_images/screen_save_diagram.png) + # Contributing Contributions are most welcome. Before proceeding, please read the [Code of Conduct](CODE_OF_CONDUCT.md) for guidance on how to approach the community and create a positive environment. Additionally, please read our [CONTRIBUTING](CONTRIBUTING.md) file, which contains guidance on ensuring a smooth contribution process. diff --git a/doc_images/screen_save_diagram.png b/doc_images/screen_save_diagram.png new file mode 100644 index 000000000..620276e95 Binary files /dev/null and b/doc_images/screen_save_diagram.png differ diff --git a/doc_images/screen_simpleUML_install.png b/doc_images/screen_simpleUML_install.png new file mode 100644 index 000000000..67633ed2e Binary files /dev/null and b/doc_images/screen_simpleUML_install.png differ diff --git a/doc_images/screen_tab_simpleUML.png b/doc_images/screen_tab_simpleUML.png new file mode 100644 index 000000000..8351ee620 Binary files /dev/null and b/doc_images/screen_tab_simpleUML.png differ diff --git a/doc_images/screen_tasto_dx_su_namespace.png b/doc_images/screen_tasto_dx_su_namespace.png new file mode 100644 index 000000000..fa3c5119f Binary files /dev/null and b/doc_images/screen_tasto_dx_su_namespace.png differ