Re: Proposal: Use Markdown syntax for README and other documentation

[dana <dana@dana.is>]

On Wed 18 May 2022, at 10:41, Bevan Stanely wrote:
> As an initial step, I have separated out the list of backward
> incompatibilities to the file COMPATIBILITY and formatted the shorter
> README

I don't feel *super* strongly about this, but i have thought before that
the README/NEWS dichotomy was slightly confusing, and that maybe the
average person would prefer it if the README just had a shorter overview
of the most important information. Not sure about the naming convention
but i would personally be OK with breaking the changes out into another
file, or combining it with NEWS, and improving the formatting and
structure of the rest of the README


On Wed 18 May 2022, at 20:10, Lawrence Velázquez wrote:
> While nice for editing, raw markup (even Markdown) makes for a poor
> reading experience.

I don't think that's necessarily the case, as demonstrated by the fact
that Bevan thought we were already using Markdown lol. And we very nearly
are

I don't think it'd be a big change to have the README standardise on some
sub-set of Markdown to make it look a little nicer on code-hosting sites,
as long as we continued to avoid the more advanced/noisy features like
images and hyper-links

But i feel even less strongly about that than the other thing


dana