polygene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From paulmer...@apache.org
Subject [18/19] zest-java git commit: Revamp the README at repository root
Date Sat, 24 Dec 2016 10:29:30 GMT
Revamp the README at repository root

It is now distinguished from the distribution READMEs


Project: http://git-wip-us.apache.org/repos/asf/zest-java/repo
Commit: http://git-wip-us.apache.org/repos/asf/zest-java/commit/56b26262
Tree: http://git-wip-us.apache.org/repos/asf/zest-java/tree/56b26262
Diff: http://git-wip-us.apache.org/repos/asf/zest-java/diff/56b26262

Branch: refs/heads/develop
Commit: 56b26262db55df6b19dcd7f2da51cfb1e93294aa
Parents: de73010
Author: Paul Merlin <paulmerlin@apache.org>
Authored: Sat Dec 24 11:15:05 2016 +0100
Committer: Paul Merlin <paulmerlin@apache.org>
Committed: Sat Dec 24 11:15:05 2016 +0100

----------------------------------------------------------------------
 README.md  | 86 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 README.txt | 64 ------------------------------------------
 2 files changed, 86 insertions(+), 64 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/zest-java/blob/56b26262/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8532123
--- /dev/null
+++ b/README.md
@@ -0,0 +1,86 @@
+# Apache Polygene™ (Java Edition)
+
+> Composite Oriented Programming on the Java platform
+
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Build Status](https://builds.apache.org/buildStatus/icon?job=Polygene(JavaEdition)-develop-java8-checkDists)](https://builds.apache.org/view/P/view/Polygene/job/Polygene(JavaEdition)-develop-java8-checkDists/)
+
+## What is Apache Polygene™
+
+The short answer is that **Apache Polygene™** is a community based effort exploring Composite
Oriented Programming for
+domain centric application development. This includes evolved concepts from
+[Aspect Oriented Programming](https://en.wikipedia.org/wiki/Aspect-oriented_programming),
+[Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection)
+and [Domain Driven Design](https://en.wikipedia.org/wiki/Domain-driven_design).
+
+**Composite Oriented Programming** allows developers to work with _fragments_, smaller than
classes, and _compose_
+fragments into larger _composites_ which acts like the regular objects. Apache Polygene™
also tackles the enforcement
+of _application_ composition, i.e. composites are declared in _modules_, modules are contained
in _layers_ and access
+between layers are controlled/enforced.
+
+**Apache Polygene™ (Java Edition)**, first Apache Polygene sub-project, is an implementation
of Composite Oriented
+Programming, using the standard Java platform, without the use of any pre-processors or new
language elements.
+Everything you know from Java still applies and you can leverage both your experience and
toolkits to become more
+productive with Composite Oriented Programming today.
+
+The Apache Polygene™ community welcomes any effort exploring Composite Oriented Programming
for domain centric
+application development using any technology.
+
+Please see https://polygene.apache.org for more information.
+
+## Downloading
+
+You can download released versions from: https://polygene.apache.org/download.html
+
+## Building
+
+Build instructions can be found here: http://polygene.apache.org/java/latest/build-system.html
+
+## Contributing
+
+Polygene™ started in 2007, and is still in heavy development under the umbrella of
+the Apache Polygene™ project at the Apache Software Foundation. We would like
+developers around the world to participate in the advancement of this
+cool, new and challenging technology. We are especially interested in
+people willing to help improve the SDK, samples, tutorials, documentation
+and other supporting material.
+
+Please see http://polygene.apache.org/community/participate.html and http://zest.apache.org/community/playing_field.html
+for more information.
+
+## Opening in your IDE
+
+### IntelliJ IDEA
+
+IntelliJ IDEA Community Edition has everything you need to open Apache Polygene™.
+To open the project in IDEA, simply open this repository as a project. 
+
+### Netbeans
+
+To open Apache Polygene™ in Netbeans you need to install the _Gradle Support_ plugin.
+It is directly available via the Update Center (Tools/Plugins: Look for _Gradle Support_).
+Then, to open the project in Netbeans, simply open this repository as a project.
+
+### Eclipse
+
+Eclipse supports Gradle based projects out of the box thanks to the Buildship project.
+To open the project in Eclipse, simply import this repository as a Gradle project.
+
+## Licensing
+
+    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.
+
+

http://git-wip-us.apache.org/repos/asf/zest-java/blob/56b26262/README.txt
----------------------------------------------------------------------
diff --git a/README.txt b/README.txt
deleted file mode 100644
index a27ea07..0000000
--- a/README.txt
+++ /dev/null
@@ -1,64 +0,0 @@
-
-Welcome to the world of Apache Polygene
-   - Composite Oriented Programming on the Java platform.
-
-
-This Apache Polygene™ Source Distribution contains everything you need to
-create Polygene™ applications.
-
-
-Polygene™ started in 2007, and is still in heavy development under the umbrella of
-the Apache Polygene™ project at the Apache Software Foundation. We would like
-developers around the world to participate in the advancement of this
-cool, new and challenging technology. We are especially interested in
-people willing to help improve the SDK, samples, tutorials, documentation
-and other supporting material.
-
-Please see https://polygene.apache.org for more information.
-
-
-Licensing
----------
-All Polygene™ code is licensed under an Apache License.
-
-Third-Party Dependencies may be licensed under other terms. The only
-required dependencies are SLF4J (MIT Licence), ASM (BSD Licence) and
-Joda-Time (Apache Licence).
-
-Finally, Polygene™ TestSupport depends on JUnit 4.x and its dependencies, which
-is also not included in the SDK itself, as it is present among most Java
-developers.
-
-
-Dependencies not included
--------------------------
-The source distribution contains Polygene™ sources only to keep the download
-size small. The Gradle build automatically downloads needed dependencies.
-If you need to go offline type `./gradlew goOffline` to ensure all needed
-dependencies are cached by Gradle.
-
-If you prefer to use a dependency management system, go to:
-https://polygene.apache.org/java/latest/howto-depend-on-polygene.html
-
-
-Building Apache Polygene
----------------------
-To build Polygene™ from sources you only need to have a valid Java JDK >= 7
-installation.
-
-If you want to build the Polygene™ manual, then you also need valid Asciidoc
-(http://www.methods.co.nz/asciidoc/) and Docbook-XSL installations.
-
-Here is how to run a full build with checks:
-
-    ./gradlew check assemble
-
-Read the Polygene™ Build System tutorial for more details:
-https://polygene.apache.org/java/latest/build-system.html
-
-
-Thank you for trying out Apache Polygene™ and Composite Oriented Programming.
-
-
--- Apache Polygene™ Team
-


Mime
View raw message