Re: [docs] [poky] [PATCH] README.poky: Update to switch to markdown format and update

["Quentin Schulz" <quentin.schulz@streamunlimited.com>]

Hi Richard,

On Mon, Jun 07, 2021 at 04:36:22PM +0100, Richard Purdie wrote:
> Mentioning on the docs list.
> 
> I a plan is forming to migrate the various READMEs in the repos to markdown
> format and display these in the git web interface in the about page. If this

Does it need to be in MarkDown format to be displayed in the About
section?

> merges I'll work with MichaelH to make sure it displays properly on the
> about page.
> 
> I've had a go at improving the poky one which needed a bit of modernisation
> anyway. Help with others welcome.
> 

Anyway to have those two changes separate so we can properly review each
separately?

> I am a little torn on this as it does make the README harder to read
> outside of rendered interfaces.
> 

But it'd be displayed correctly in the Github mirror and Gitlab for
those using it I guess.

Most projects hosted on Github/Gitlab use MarkDown so I don't think it's
such a bad idea, I'm just not sure it has as much benefit on cgit since
it's not the landing page of the repo (the summary page is).

If we can display the non-MD version in the about page, I don't think
there's a huge benefit of migrating to MD?

If we absolutely need MD for the about page, go for it as it'll cover
Github, Gitlab and probably others.

We might want to modify bitbake-layers create-layer to provide a
README.md too instead of the current template?

Cheers,
Quentin