search

fortran-lang / fftpack

Double precision version of fftpack
https://fortran-lang.github.io/fftpack/
Other
68 stars 19 forks source link

Reorganize & clarify documentation structure #50

Closed rouson closed 7 months ago

rouson commented 7 months ago

The primary goal of this PR is to save time for newcomers looking for Fortran-lang/fftpack's documentation. This PR does the following:

  1. Adds a new doc/README.md file that a. Directs the reader to the GitHub Pages documentation deployed in HTML form by this repository's CI scripts, b. Provides a ford command for generating the same HTML files locally, c. Clarifies the structure and purpose of the files in the doc/ subdirectory,
  2. Moves the documentation for prior fftpack incarnations to a new legacy/ subdirectory,
  3. Improves the formatting of a bullet list in the root-directory README.md, and
  4. Fixes the author email metadata tag in the ford project file.

The main point is to divert anyone looking for readily consumable documentation in the doc/ subdirectory unless they're interested in the legacy documentation.

rouson commented 7 months ago

@zoziha on this and other PRs, I'm requesting your review because GitHub reports that you have contributed the most to this repository so I assume you're the most interested and/or have the most at stake. Others are welcome to review or someone can let me know if it's ok to merge without review. I did merge one or two trivial PRs without review.