doc(ford): add documentation file; adjust README

README.md

@@ -2,32 +2,32 @@ Sourcery Library
 ================
 
 A grab bag of useful tricks in Fortran 2018.
-```
-            `.                              
-                      -:/+-                            
-                    `/oydddy/`                         
-                   `/sdmNNmmdh/`                       
-                   /odNNmNmyshdh/`                     
-                  -+ymNNmmms``.ohy.                    
-                 `+odmNNmdmm+`  `.`                    
-                 -+sdmNNNmdmmo.                        
-                 /+ydmNNNmddmms-                       
-                -+ohmmNNNNmddmmy:                      
-                /+ohmmNNNNmdhdmmy/`                    
-               .++shdmNNNNNmdhdmmh/`                   
-               :/+shdmmNNNNmdhhmmmy/`                  
-              `+/+shdmmNNNNNmdhdmmmy:````````.````     
-              -//+shdmmNNNNNmdhyyyso:-sssssssssssso+-` 
-           `.-+//+shdmmmNNNNmhs/////+sdhhhyyhddhso+++: 
-       `.:oyhdo//+shdmmmNNNds//syyyyhhhhhhhdho-`       
-     `:oyhhdmh::/+shddmddy+::+hdysoosyys/-..           
-   ./ssssyhdmd:--://///:-:/sdNmdhyooo+-                
-  :ooo+oosyhdmdyo+/::/+oydmNNNNNmhs/.                  
- :+++///++osyhhhdmmmmmNNNNNNNNmdo-                     
- +++//////+oossshddmmmmmNNNmdy/`                       
- .///////+++oosyhhddmmmmddy/.                          
-   .:////+++ossyyhhhhhs+:`                             
-      `..--::/++//:-.
+
+```fortran
+                      -:/+-
+                    ./oydddy/.
+                   ./sdmNNmmdh/.
+                   /odNNmNmyshdh/.
+                  -+ymNNmmms...ohy.
+                 .+odmNNmdmm+.  ...
+                 -+sdmNNNmdmmo.
+                 /+ydmNNNmddmms-
+                -+ohmmNNNNmddmmy:
+                /+ohmmNNNNmdhdmmy/.
+               .++shdmNNNNNmdhdmmh/.
+               :/+shdmmNNNNmdhhmmmy/.
+              .+/+shdmmNNNNNmdhdmmm##.............
+              -//+shdmmNNNNNmdhyyy##--sssssssssssso+-.
+           ..-##/+shdmmmNNNNmhs/##//+sdhhhyyhddhso+++:
+       ..:oyh## /+shdmmmNNNds##syyyyhhhhhhhdho-.
+     .:oyhhdmh##/+shddmddy+##+hdysoosyys/-..
+   ./ssssyhdmd:-##//////##ndifmdhyooo+-
+  :ooo+oosyhdmdyo+######ydmNNNNNmhs/.
+ :+++///++osyhhhdmmmmmNNNNNNNNmdo-
+ +++//////+oossshddmmmmmNNNmdy/.
+ .///////+++oosyhhddmmmmddy/.
+   .:////+++ossyyhhhhhs+:.
+      ---..........--
 ```
 
 Utility functions

doc/ford-documentation.md

@@ -0,0 +1,26 @@
+project:
+summary: A Fortran 2018 utility library.
+src_dir: ../src
+output_dir: html
+preprocess: true
+macro: FORD
+preprocessor: gfortran -E
+display: public
+         protected
+         private
+source: true
+graph: true
+md_extensions: markdown.extensions.toc
+coloured_edges: true
+sort: permission-alpha
+extra_mods: iso_fortran_env:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fFORTRAN_005fENV.html
+            iso_c_binding:https://gcc.gnu.org/onlinedocs/gfortran/ISO_005fC_005fBINDING.html#ISO_005fC_005fBINDING
+project_github: https://github.com/sourceryinstitute/sourcery
+author: Damian Rouson
+print_creation_date: true
+creation_date: %Y-%m-%d %H:%M %z
+project_github: https://github.com/sourceryinstitute/sourcery
+project_download: https://github.com/sourceryinstitute/sourcery/releases
+github: https://github.com/sourceryinstitute
+
+{!../README.md!}