Re: [PATCH 2/5] Add a toplevel README

[Siddhesh Poyarekar <siddhesh@gotplt.org>]

On 2024-03-07 16:06, Carlos O'Donell wrote:
> On 3/7/24 16:00, Siddhesh Poyarekar wrote:
>> On 2024-03-07 15:25, Carlos O'Donell wrote:
>>> On 3/7/24 14:30, Siddhesh Poyarekar wrote:
>>>> Add basic instructions to allow one to test and later submit changes for
>>>> review and inclusion.
>>>>
>>>> Signed-off-by: Siddhesh Poyarekar <siddhesh@gotplt.org>
>>>
>>> Content looks good though, you can keep my RB and push so long as you call it README.md.
>>>
>>> Reviewed-by: Carlos O'Donell <carlos@redhat.com>
>>
>> I'm calling it README.rst instead, since it's more rst than md.  Is that fine?
> 
> No. The README.md is intended to be rendered by forges that mirror the repo
> and should be in markdown regardless of what we use for the project itself
> (rST). For example Github only renders markdown and a README.rst would not
> be rendered there, we'd need to use pandoc to sync an update of the same
> file but converted.
> 
> Suggestion: Call it README.md; and keep it in markdown.
> 

Ack, I changed the name (and format, e.g. # for h1, `` for code blocks, 
etc.) to markdown and pushed this.

Sid