Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,13 @@ Classes

Prerequisites
-------------
The following are the versions or commits currently employed in
developing and testing. Earlier versions or commits might work also.
The following are the prerequisite package versions/commits currently
employed in developing and testing (_earlier versions/commits might work also_):

* Compiler: [GNU Fortran] (gfortran) 10.2.0
* Parallel runtime library: [OpenCoarrays] 2.9.0
* Parallel runtime library: [OpenCoarrays] 2.9.2
* Fortran package manager: [fpm] 7d320295c6fe56cc767b352bd26f0466aa29ac5c
* _Optional_: [FORD] 6.0.0 for producing HTML documentation.

This library also uses the [vegetables] unit testing framework, which
the [fpm] build system will install automatically.
Expand All @@ -75,13 +76,16 @@ emulated instrinsic procedures, which are intended for use with
compiler versions that lack support for the named features. Delete
those flags with compilers that support these features.

Build documentation
-------------------
Building the documentation
--------------------------
After installing python and `ford` (via `pip install ford`), execute
```zsh
ford doc/ford-documentation.md
```
after which opening subdirectory `doc/html/index.html` in a browser.

[GNU Fortran]: https://gcc.gnu.org
[OpenCoarrays]: https://github.com/sourceryinstitute/opencoarrays
[fpm]: https://github.com/fortran-lang/fpm
[vegetables]: https://gitlab.com/everythingfunctional/vegetables
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
1 change: 1 addition & 0 deletions doc/ford-documentation.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
project:
summary: A Fortran 2018 utility library.
src_dir: ../src
src_dir: ../tests
output_dir: html
preprocess: true
macro: FORD
Expand Down