Skip to content

Commit 02e7e57

Browse files
authored
Merge pull request #45 from fortran-lang/edit-readme
Documentation updates
2 parents f56daca + 4f0b02b commit 02e7e57

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,19 @@ 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)
71-
- [NACR/FFTPACK 5.1](https://www2.cisl.ucar.edu/resources/legacy/fft5)
67+
## Documentation
68+
See the our [GitHub Pages site] for documentation generated by [FORD] from the fortran-lang/fftpack [project file].
69+
70+
## References
71+
Although fortran-lang is _not_ interface-compatible with any of the following libraries, each contains documentation that might be useful for different reasons:
72+
- **Recommended reference:** The [scipy.fftpack] documentation contains succinct description of the storage sequences for function results that match those in fortran-lang/fftpack, e.g., the location of the real and imaginary parts of the `rfft` function result.
73+
- **Theory reference:** The [documentation for the GNU/gsl FFT routines], which are 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+
- **Historical reference:** The [netlib/fftpack] library on which fortran-lang/fftpack is useful for understanding several fortran-lang/fftpack design choices, e.g., the procedure dependencies.
75+
76+
[FORD]: https://github.com/Fortran-FOSS-Programmers/ford
77+
[project file]: ./API-doc-FORD-file.md
78+
[scipy.fftpack]: https://docs.scipy.org/doc/scipy/reference/fftpack.html
79+
[documentation for the GNU/gsl FFT routines]: https://www.gnu.org/software/gsl/doc/html/fft.html#
80+
[netlib/fftpack]: http://www.netlib.org/fftpack/
81+
[LaTeX]: https://www.latex-project.org
82+
[GitHub Pages site]: https://fortran-lang.github.io/fftpack/

0 commit comments

Comments
 (0)