You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@tomee.apache.org by "Roberto Cortez (JIRA)" <ji...@apache.org> on 2018/12/12 22:26:00 UTC

[jira] [Created] (TOMEE-2361) Improve main README file

Roberto Cortez created TOMEE-2361:
-------------------------------------

             Summary: Improve main README file
                 Key: TOMEE-2361
                 URL: https://issues.apache.org/jira/browse/TOMEE-2361
             Project: TomEE
          Issue Type: Improvement
          Components: Examples and Documentation
    Affects Versions: 8.0.0-M1
            Reporter: Roberto Cortez
             Fix For: 8.0.0-Final


Right now, our main readme file is very poor:
 [https://github.com/apache/tomee/blob/master/README.md]

I think we should improve it a bit by adding the following information:
 * Project description
 * Downloads
 * Contribution guidelines
 * Links to docs with examples or other relevant information
 * Links to tools used by the project
 * Any other relevant stuff

This may look like a duplication from the website. We can and should link to pieces of information there. On the other hand, people may find the project directly on Github and should have a minimal piece of information to get them started.



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