LupoA / lsdensities

Smeared spectral densities from lattice correlators
GNU General Public License v3.0
3 stars 0 forks source link

Don't use PDF for documentation #29

Open edbennett opened 6 months ago

edbennett commented 6 months ago

PDFs are awkward to diff, and awkward for others to update if they don't have the source (which isn't in the repository).

I'd suggest either using Markdown or reStructuredText for this. GitHub will now render equations in its Markdown, so I don't think there's a barrier to doing this.

I would suggest using a doc or documentation folder rather than documents.

Further down the line you may wish to generate a fuller set of documentation using something like Read the Docs; this also uses reStructuredText.