-
Committer:
Matthew Fuller
-
Date:
2024-01-14 00:08:17 UTC
-
mfrom:
(712.1.4 dev)
-
Revision ID:
fullermd@over-yonder.net-20240114000817-bbhni6weyulcmqun
Rewrite README and CHANGES into asciidoc.
Previously these were in multimarkdown. While we went straight to
asciidoc for the manual, these files require much less careful
formatting, so markdown seemed more appropriate. However, they still
wanted things like definition lists and some other minor stuff that plain
markdown doesn't pull off so well, so the multimarkdown dialect was
chosen.
However, mmd has proven a little fragile over the years. And the
markdown world is so wildly fragmented, and everyone looks at a .md file
and says "Oh, that must be processable by my own particular incompatible
local dialect", which means anywhere other than our Makefile trying to
render the files wound up squirrely anyway.
The README is pretty trivially and cleanly asciidoc-able. CHANGES is
somewhat less so. We wind up with a lot more noise in it from the
heavier markup of asciidoc, so it doesn't read quite as well as plain
text anymore. It's probably not too hard to simplify it down to the
common subset of markdown. But that would leave it as the _only_ bit of
processed markdown in the tree anymore, so I went ahead and adoc-ified it
just to be more consistent. So now all our built docs are asciidoc.
(n.b. there are a few README.md's in other places through the tree
that aren't touched, but they're very much ".txt that happens to look
md-ish and may process as that", so what the heck. We have no code
for or intention of actually building them into any output formats.)