[meta-freescale] [RFC][fsl-community-bsp-platform] README: Translate README to use Asciidoctor instead of markdown

Otavio Salvador otavio at ossystems.com.br
Fri Jan 9 10:30:27 PST 2015


On Fri, Jan 9, 2015 at 3:59 PM, Daiane Angolini <daiane.list at gmail.com> wrote:
> On Fri, Jan 9, 2015 at 3:39 PM, Daiane Angolini
> <daiane.angolini at freescale.com> wrote:
>> Rename file to README.adoc in order to allow Github to automatically render the
>> file when displaying it at repository's page.
>>
>> Translate markdown to asciidoctor. It's not a big change, but it includes some
>> formatting like source code highlighting.
>>
>> Remove some future tense used in the text, and fixed some other sentences.
>>
>> Signed-off-by: Daiane Angolini <daiane.angolini at freescale.com>
>
> Please, see the rendered result here
> https://github.com/angolini/fsl-community-bsp-platform/blob/master/README.adoc
>
> Does it worth the change?
>
>
> Otavio, What do you think?

I like it :-)

> Would be a problem to have the README file renamed to README.adoc?

Sure not.

-- 
Otavio Salvador                             O.S. Systems
http://www.ossystems.com.br        http://code.ossystems.com.br
Mobile: +55 (53) 9981-7854            Mobile: +1 (347) 903-9750


More information about the meta-freescale mailing list