[jira] [Commented] (OFBIZ-10272) Documentation: Convert README.md to README.adoc

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

[jira] [Commented] (OFBIZ-10272) Documentation: Convert README.md to README.adoc

Nicolas Malin (Jira)

    [ https://issues.apache.org/jira/browse/OFBIZ-10272?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16401725#comment-16401725 ]

Michael Brohl commented on OFBIZ-10272:
---------------------------------------

Thanks Sharan!

Do you you anyone else see a problem in replacing the original README.md with README.adoc?

I think .adoc will be displayed as well as .md on Github or similar platforms.

We could then also include the README in the main documentation (some kind of "Getting started" section).

Makes sense?

> Documentation: Convert README.md to README.adoc
> -----------------------------------------------
>
>                 Key: OFBIZ-10272
>                 URL: https://issues.apache.org/jira/browse/OFBIZ-10272
>             Project: OFBiz
>          Issue Type: Improvement
>          Components: framework
>    Affects Versions: Trunk
>            Reporter: Michael Brohl
>            Assignee: Michael Brohl
>            Priority: Minor
>              Labels: asciidoc, documentation
>         Attachments: OFBIZ-10272_Convert_README.md_to_README.adoc.patch, OFBIZ-10272_Convert_README.md_to_README.adoc.patch
>
>
> Convert the main README to asciidoc format.



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)