Skip to content

Commit 5ed2686

Browse files
author
Damian Rouson
authored
Merge pull request #26 from sourceryinstitute/link-readme-to-pages
doc(README): link to GitHub Pages site
2 parents 5d811cb + da35cb5 commit 5ed2686

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,21 +40,26 @@ from the Sourcery repository. Examples include the [Assert] and [Emulators]
4040
libraries. Following the practice of [semantic versioning], code removal
4141
causes an increment in the major version number.
4242

43-
Procedures
44-
---------
43+
Contents
44+
--------
45+
46+
### Procedures
4547

4648
* Array functions
4749
* String functions
48-
* User-defined collective subroutines: `co_all`
50+
* User-defined collective subroutines
4951

50-
Classes
51-
-------
52+
### Classes
5253
* Parallel data partitioning and gathering,
5354
* (Co-)[Object pattern] abstract parent,
54-
* Runtime units tracking, and
55-
* A test oracle using the [Template Method pattern].
55+
* Runtime units tracking,
56+
* A test oracle using the [Template Method pattern], and
5657
* A command-line abstraction that searches for program arguments.
5758

59+
Documentation
60+
-------------
61+
See the [Sourcery GitHub Pages site] for HTML documentation generated with [`ford`]:
62+
5863
Prerequisites
5964
-------------
6065
[FORD] 6.1.0 or later is required for producing HTML documentation (see
@@ -101,3 +106,6 @@ documentation.
101106
[Template Method pattern]: https://en.wikipedia.org/wiki/Template_method_pattern
102107
[Downloding, Building, and Testing]: #downloding-building-and-testing
103108
[Building the documentation]: #building-the-documentation
109+
[Sourcery GitHub Pages site]: http://sourceryinstitute.github.io/sourcery/
110+
[`ford`]: https://github.com/Fortran-FOSS-Programmers/ford
111+

0 commit comments

Comments
 (0)