Skip to content

Commit 588c2d6

Browse files
authored
doc(README): add UML class diagram image
1 parent 1fed8ce commit 588c2d6

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,20 @@ into submodules.
4242
As compared to the original code, this repository also adds
4343
1. A [Fortran Package Manager] build system,
4444
2. Tests based on the [Vegetables] unit-testing software,
45-
3. Documentation generated by [FORD] and deployed to the web via GitHub Actions, and
45+
3. Documentation generated by [`ford`] and deployed to the web via GitHub Actions, and
4646
4. Quality control via continuous integration testing using GitHub Actions.
4747

4848
Documentation
4949
-------------
5050
See [Reference Counter's GitHub Pages site] for HTML documentation generated with [`ford`].
5151

52+
See the [doc/] subdirectory for a [PlantUML] script that generates the Unified Modeling Langauge (UML) class diagram below of the three derived types in reference-counter.
53+
54+
![class_diagram](https://user-images.githubusercontent.com/13108868/165135689-4d2e85fe-6946-472f-a154-aaabebf6d4f5.png)
55+
56+
The above image was created with the PlantuML package in the [Atom] editor.
57+
58+
5259
Compiler Status
5360
---------------
5461
Correct execution of the Reference Counter library code requires comprehensive
@@ -110,5 +117,8 @@ fpm test --compiler flang --flag -cpp
110117
[3]: https://doi.org/10.1109/MCSE.2012.33
111118
[Fortran Package Manager]: https://github.com/fortran-lang/fpm
112119
[Vegetables]: https://gitlab.com/everythingfunctional/vegetables
113-
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
120+
[`ford`]: https://github.com/Fortran-FOSS-Programmers/ford
114121
[Reference Counter's GitHub Pages site]: https://sourceryinstitute.github.io/reference-counter
122+
[Atom]: https://atom.io
123+
[PlantUML]: https://plantuml.com
124+
[doc/]: ./doc

0 commit comments

Comments
 (0)