Skip to content

Commit 24a667b

Browse files
author
Damian Rouson
authored
Update README.md
1 parent 62b1bae commit 24a667b

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,16 @@ The `characterizable_t` type defines an `as_character()` deferred binding that p
2828

2929
The `intrinsic_array_t` type that extends `characterizable_t` provides a convenient mechanism for producing diagnostic output from arrays of intrinsic type `complex`, `integer`, `logical`, or `real`.
3030

31+
Documentation
32+
-------------
33+
See [Assert's GitHub Pages site] for HTML documentation generated with [`ford`].
34+
3135
Use Cases
3236
---------
37+
Two common use cases include
38+
3339
1. [Enforcing programming contracts] throughout a project via runtime checks.
34-
2. Produce output in `pure` procedures for debugging purposes.
40+
2. Producing output in `pure` procedures for debugging purposes.
3541

3642
### Enforcing programming contracts
3743
Programming can be thought of as requirements for correct execution of a procedure and assurances for the result of correct execution.
@@ -98,3 +104,5 @@ For further documentation, please see [example/README.md] and the [tests]. Also
98104
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
99105
[Fortran Package Manager]: https://github.com/fortran-lang/fpm
100106
[OCL]: https://en.wikipedia.org/wiki/Object_Constraint_Language
107+
[Assert's GitHub Pages site]: https://sourceryinstitute.github.io/assert/
108+
[`ford`]: https://github.com/Fortran-FOSS-Programmers/ford

0 commit comments

Comments
 (0)