Skip to content

Commit 9960f0a

Browse files
committed
doc(README): link to GH Pages, describe references
This commit edits the root directory's README.md file to 1. Add a link to the FORD documentation on GitHub Pages and 2. Add descriptions of the possible utility of the documentation of other netlib/fftpack-based libraries.
1 parent f9c81fb commit 9960f0a

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

README.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,18 @@ meson configure build --prefix=/path/to/install
6464
meson install -C build
6565
```
6666

67-
## Links
68-
- [netlib/dfftpack1.0(fftpack4.0)](http://www.netlib.org/fftpack/)
69-
- [Documents of fft routines in GNU/gsl based on `netlib/fftpack`](https://www.gnu.org/software/gsl/doc/html/fft.html#)
70-
- [Documents of scipy.fftpack](https://docs.scipy.org/doc/scipy/reference/fftpack.html)
67+
## Documentation
68+
See [https://fortran-lang.github.io/fftpack/](https://fortran-lang.github.io/fftpack/) for documentation generated by this repository's [FORD] [project file].
69+
70+
## References
71+
- [Recommended reference]: Although this SciPy version is in Python and the procedures have different arguments from [fortran-lang/fftpack], the SciPy fftpack documentation provides a succinct description of the storage sequence for the function results in both scipy.fftpack and [fortran-lang/fftpack], e.g., the storage sequence for the `rfft` function result.
72+
- [Historical reference]: This is the netlib/fftpack library on which [fortran-lang/fftpack] is based but the two are _not_ interface-compatible.
73+
- [Theory reference]: The documentation for the GNU/gsl FFT routines, which is also based on netlib/fftpack, provides some useful definitions of FFT terminology and represenations of the analytical forms of the Discrete Fourier Transform nicely formatted by [LaTeX].
74+
75+
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
76+
[project file]: ./API-doc-FORD-file.md
77+
[fortran-lang/fftpack]: https://github.com/fortran-lang/fftpack
78+
[Recommended reference]: https://docs.scipy.org/doc/scipy/reference/fftpack.html
79+
[Historical reference]: http://www.netlib.org/fftpack/
80+
[Theory reference]: https://www.gnu.org/software/gsl/doc/html/fft.html#
81+
[LaTeX]: https://www.latex-project.org

0 commit comments

Comments
 (0)