I would be huge fan of this.  It makes it a lot more approachable, I had
started converting the main readme in particular but I did not get very
far. It's a lot of work.

Did you see Adams work here
https://nuttx-companion.readthedocs.io/en/latest/

I thought it would be really nice to integrate the board list with the
readme content into it. (While keeping the content readable in the source
control).

You already seeing the Linux kernel making some progress in this direction
(not quite markdown)
https://www.kernel.org/doc/html/v4.10/index.html

We are already using some markup of sorts so I don't see why this would be
a problem, but that's just my one opinion.

--Brennan

On Wed, Jul 15, 2020, 6:27 PM Matias N. <mat...@imap.cc> wrote:

> Hi,
> what do you think about using Markdown for README files? I think the
> syntax is good for direct reading but it also has the added benefit of
> being supported with nice rendering in different platforms, such as GitHub
> itself. Maybe this can also be used to expose the READMEs in the
> wiki/website which I understand are also in Markdown.
>
> Best,
> Matias

Reply via email to