From 22ec2cc07c1b0a876e1c8c40327b9d4f78fe5ba8 Mon Sep 17 00:00:00 2001 From: Damian Rouson Date: Sun, 17 Mar 2024 17:05:21 -0700 Subject: [PATCH] doc(README.md): clarify documentation structure --- doc/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 doc/README.md diff --git a/doc/README.md b/doc/README.md new file mode 100644 index 0000000..e1f1346 --- /dev/null +++ b/doc/README.md @@ -0,0 +1,17 @@ +Fortran-lang/fftpack Documentation +================================== + +Please see the [GitHub Pages site] for the Fortran-lang/fftpack documentation. +To generate a local copy of the corresponding HTML files, + +1. Set your present working directory to the Fortran-lang/fftpack project root directory, +2. Execute `ford API-doc-FORD-file.md`, and +3. View the result by opening the newly generated `API-doc/` subdirectory in a web browser. + +This subdirectory contains +1. Documentation files for previous incarnations of fftpack in the [legacy](./legacy) sudirectory and +2. Files supporting the [API-doc-.md](../API-doc-FORD-file.md) project file that [FORD] uses to generate the GitHub Pages site. + + +[FORD]: https://github.com/Fortran-FOSS-Programmers/ford +[GitHub Pages site]: https://fortran-lang.github.io/fftpack/