click-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From aadr...@apache.org
Subject svn commit: r1543953 - in /click/trunk/click: README.md README.txt
Date Wed, 20 Nov 2013 21:18:52 GMT
Author: aadrian
Date: Wed Nov 20 21:18:52 2013
New Revision: 1543953

URL: http://svn.apache.org/r1543953
Log:
doco

Added:
    click/trunk/click/README.md   (with props)
Modified:
    click/trunk/click/README.txt

Added: click/trunk/click/README.md
URL: http://svn.apache.org/viewvc/click/trunk/click/README.md?rev=1543953&view=auto
==============================================================================
--- click/trunk/click/README.md (added)
+++ click/trunk/click/README.md Wed Nov 20 21:18:52 2013
@@ -0,0 +1,108 @@
+Welcome to Click
+================
+
+Apache Click™ is a modern JEE web application framework, providing a natural rich client
style programming model.
+Apache Click is designed to be very easy to learn and use, with developers getting up and
running within a day.
+
+Documentation
+=============
+
+Comprehensive HTML documentation is available online at:
+
+[http://click.apache.org/](http://click.apache.org/)
+
+The documentation is also available from the directory:
+
+  `documentation/`
+
+
+Release Notes
+=============
+
+Detailed release notes are available here:
+
+  `documentation/docs/roadmap-changes.html`
+
+
+Distribution Jars
+=================
+
+Distributed Click JAR files include:
+
+   `dist/click-xx.jar`        - Click runtime JAR including dependencies
+
+   `dist/click-nodeps-xx.jar` - Click runtime JAR with no dependencies
+
+   `dist/click-extras-xx.jar` - Click Extras JAR
+
+   `dist/click-mock-xx.jar`   - Click Mock Utilities JAR
+
+
+Examples
+========
+
+Example pre-built web application include:
+
+   `dist/click-examples.war`
+
+
+Build Information
+=================
+
+Click is built using the J2SE 1.5.0 and Apache Ant
+
+The Ant `build.xml` and `build.properties` files are located in
+the `build/` directory.
+
+The main Ant targets include:
+
+    build-all             build framework, extras, examples
+    build-distribution    build distribution ZIP file
+    build-examples        build click-examples WAR file
+    build-extras          build click-extras JAR file
+    build-framework       build click framework JAR file
+    build-maven-bundles   build Maven repository upload bundles
+    build-mock            build mock JAR file
+    build-sources         build source ZIP files for use with IDEs
+    checkstyle            run checkstyle report on Java source
+    deploy-examples       copy example WAR files to app server
+    get-deps              download JAR dependencies
+    get-deps-proxy        download JAR dependencies via proxy
+    help                  display the Help message
+    javadoc               create Javadoc HTML files
+    project-quick-start   build application template
+    test-all              run all unit tests
+
+
+Before building the framework, all third-party library dependencies must be
+downloaded using the command:
+
+    ant get-deps
+
+or in the case of running behind a proxy, by using the command:
+
+    ant get-deps-proxy
+
+To run all tests execute the command:
+
+    ant test-all
+
+To build a new distribution run:
+
+    ant build-distribution
+
+To build the core library, click-x.x.x.jar, run:
+
+    ant build-framework
+
+To build the extras library, click-extras.x.x.x.jar, run:
+
+    ant build-extras
+
+To build the documentation (PDF and HTML) please see:
+
+    documentation/xdocs/README.txt
+
+Further information on building Click is available here:
+
+   `documentation/docs/developer-guide/building.html`

Propchange: click/trunk/click/README.md
------------------------------------------------------------------------------
    svn:eol-style = native

Modified: click/trunk/click/README.txt
URL: http://svn.apache.org/viewvc/click/trunk/click/README.txt?rev=1543953&r1=1543952&r2=1543953&view=diff
==============================================================================
--- click/trunk/click/README.txt (original)
+++ click/trunk/click/README.txt Wed Nov 20 21:18:52 2013
@@ -2,9 +2,8 @@
 Welcome to Click
 ================
 
-Click is a J2EE web application framework featuring a Page
-and Component oriented design. Click is an open source project 
-licensed using the Apache license. 
+Apache Click™ is a modern JEE web application framework, providing a natural rich client
style programming model.
+Apache Click is designed to be very easy to learn and use, with developers getting up and
running within a day.
 
 
 Documentation



Mime
View raw message