Skip to content

Commit

Permalink
doc(README.md): clarify documentation structure
Browse files Browse the repository at this point in the history
  • Loading branch information
rouson committed Mar 18, 2024
1 parent 7168717 commit 22ec2cc
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -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/

0 comments on commit 22ec2cc

Please sign in to comment.