Skip to content

Commit 22ec2cc

Browse files
committed
doc(README.md): clarify documentation structure
1 parent 7168717 commit 22ec2cc

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

doc/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Fortran-lang/fftpack Documentation
2+
==================================
3+
4+
Please see the [GitHub Pages site] for the Fortran-lang/fftpack documentation.
5+
To generate a local copy of the corresponding HTML files,
6+
7+
1. Set your present working directory to the Fortran-lang/fftpack project root directory,
8+
2. Execute `ford API-doc-FORD-file.md`, and
9+
3. View the result by opening the newly generated `API-doc/` subdirectory in a web browser.
10+
11+
This subdirectory contains
12+
1. Documentation files for previous incarnations of fftpack in the [legacy](./legacy) sudirectory and
13+
2. Files supporting the [API-doc-.md](../API-doc-FORD-file.md) project file that [FORD] uses to generate the GitHub Pages site.
14+
15+
16+
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
17+
[GitHub Pages site]: https://fortran-lang.github.io/fftpack/

0 commit comments

Comments
 (0)