[tomee] 01/05: TOMEE-2361 Initial work

[ra...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

radcortez pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/tomee.git

commit 807290ee68df6f1fd4951e92e88e43122a7bc05e
Author: CesarHernandezGt <cf...@gmail.com>
AuthorDate: Thu Dec 20 20:34:51 2018 -0600

    TOMEE-2361 Initial work
---
 README.md | 121 +++++++++++++++++++++++++++++++++++++++++++++++++++-----------
 1 file changed, 101 insertions(+), 20 deletions(-)

diff --git a/README.md b/README.md
index 2f8f33a..b15a518 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,123 @@
-Title: Buildling Instructions
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!--- badget section missing:
+  Jiras opened ? I don't know if this information can be pulled from JIRA
+  Bug issues ? I don't know if this information can be pulled from JIRA
+  Gitter ? We currently have IRC, do we want to add Gitter to the channels?
+-->
 
-# Basic Usage
 
-Apache TomEE is built with Apache Maven.
+ 
 
-Simply use
+[![License](http://img.shields.io/:license-apache-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
+[![GitHub forks](https://img.shields.io/github/forks/apache/tomee.svg?style=social&label=Fork)](https://github.com/apache/tomee/tomee/fork) 
+[![GitHub stars](https://img.shields.io/github/stars/apache/tomee.svg?style=social&label=Star)](https://github.com/apache/tomee) 
 
-`$> mvn clean install`
+#<img src="http://tomee.apache.org/img/logo-active.png">  Apache TomEE 
 
-on your commandline to kick off the compile process of TomEE
+Apache TomEE is a lightweight, yet powerful, JavaEE Application server with feature rich tooling.
 
+Is the Java Enterprise Edition of Apache Tomcat (Tomcat + Java EE = TomEE) and currently is a JakartaEE (formerly JavaEE) and Microprofile compliant application server.
 
-If you intend building in environments where multicast is not allowed
-then build with:
+Official website: [https://tomee.apache.org](https://tomee.apache.org)
 
-`$> mvn clean install -DskipMulticastTests=true`
+---
 
-Full build can be executed with (will execute arquillian test on all TomEE distributions)
+- [To start using TomEE](#to-starti-using-tomee)
+- [To start developing TomEE](#to-start-developing-tomEE)
+- [Contributing](#contributing)
+- [Changelog](#changelog)
+- [License](#license)
 
-`$> mvn clean install -Pall-adapters`
 
- 
-# Quick Build
- 
-If you only like to compile all classes and package up TomEE *without* running tests
+---
+
+## To start using TomEE
+
+* Apache TomEE is distributed 5 different flavors, you can check the [comparison](http://tomee.apache.org/comparison.html) 
+table and then proceed to [donwload](http://tomee.apache.org/download-ng.html) the distribution for your use case. 
+    
+* [Documentation and examples](http://tomee.apache.org/docs.html) are available in the official website.
+
+   
+
+
+## To start developing TomEE
+
+Apache TomEE is built with Apache Maven >= 3.3.9 and Java 8. The [Contribute to TomEE](http://tomee.apache.org/community/sources.html) section from the official website for a complete 
+Git, Github, Build, Test, and Continuous Integration details.
+
+
+    
+### Quick build
+
+If you only like to compile all classes and package up TomEE *without* running tests 
 then you can use the following build options
+    
+    mvn -Pquick -Dsurefire.useFile=false -DdisableXmlReport=true -DuniqueVersion=false -ff -Dassemble -DskipTests -DfailIfNoTests=false clean install
+    
+### Full build
 
-`mvn -Pquick -Dsurefire.useFile=false -DdisableXmlReport=true -DuniqueVersion=false -ff -Dassemble -DskipTests -DfailIfNoTests=false clean install`
+    mvn clean install
+    
 
-# Direct builds
+If you intend building in environments where multicast is not allowed
+then build with:
+    
+    mvn clean install -DskipMulticastTests=true
+    
+Full build that execute arquillian test on all TomEE distributions:
+    
+    mvn clean install -Pall-adapters
+    
+### Partial build    
 
-To build TomEE just execute:
+To build just TomEE distribution execute:
 
-`$> mvn clean install -pl tomee/apache-tomee -am -Dmaven.test.skip=true`
+    mvn clean install -pl tomee/apache-tomee -am -Dmaven.test.skip=true
 
 TomEE zip/tar.gz will be in tomee/apache-tomee/target
 
 To build TomEE Embedded to be able to develop with its maven plugin execute:
 
-`$> mvn clean install -pl maven/tomee-embedded-maven-plugin -am -Dmaven.test.skip=true`
+    mvn clean install -pl maven/tomee-embedded-maven-plugin -am -Dmaven.test.skip=true
+
+
+## Contributing
+
+The [community](http://tomee.apache.org/community/index.html) section from the official website offers details on how you
+can join the mailing lists, file tickets, fix bugs and start to contribute to the project. 
+
+
+## Changelog
+
+List of [Jira Releases](https://issues.apache.org/jira/projects/TOMEE?selectedItem=com.atlassian.jira.jira-projects-plugin:release-page&status=released) 
+(*)
+
+(*) You need to login or sign up with a free Apache Jira Account
+
+ 
+
+## License
+
+[Apache License 2.0](LICENSE)
+
+
+
+