Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(README): add link to ford documentation #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ in language extensions such as the [Sourcery] library's `co_all` subroutine,
which provides a parallel, collective `logical` operation analogous to the
`all` intrinsic function.

Documentation
-------------
See the [Emulators GitHub Pages site] for HTML documentation generated with [`ford`].

Prerequisites
-------------
Emulators builds with a Fortran compiler that supports the following features:
Expand Down Expand Up @@ -75,3 +79,5 @@ fpm test --flag "-cpp -DEMULATE_INTRINSICS -DEMULATE_COLLECTIVES -fcoarray=singl
[issue]: https://github.com/sourceryinstitute/hope/issues
[pull request]: https://github.com/sourceryinstitute/hope/pulls
[fpm]: https://github.com/fortran-lang/fpm
[Emulators GitHub Pages site]: http://sourceryinstitute.github.io/emulators/
[`ford`]: https://github.com/Fortran-FOSS-Programmers/ford