[seam-commits] Seam SVN: r10721 - modules/trunk.

[seam-commits at lists.jboss.org]

Author: dan.j.allen
Date: 2009-04-29 12:28:36 -0400 (Wed, 29 Apr 2009)
New Revision: 10721

Added:
   modules/trunk/readme.txt
Log:
add a readme


Added: modules/trunk/readme.txt
===================================================================
--- modules/trunk/readme.txt	                        (rev 0)
+++ modules/trunk/readme.txt	2009-04-29 16:28:36 UTC (rev 10721)
@@ -0,0 +1,56 @@
+
+Seam - An integrated development platform based on the Java EE environment
+==========================================================================
+
+Seam is distributed under the terms of the GNU Lesser General Public License.
+ => license avaialble at dist/lgpl.txt
+
+Building Seam (for developers)
+------------------------------
+
+These instructions assume that you are working with a local checkout of the
+Seam repository (Seam 3 and above).
+
+The Seam source code is partitioned into several SVN roots. Starting with Seam
+3, the Seam framework is a modular set of add-ons for the Java EE environment,
+based primarily on the JSR-299 contexts and dependency injection services. As
+such, there is no longer a Seam "core". The core is JSR-299 and other parts of
+Java EE. This makes it easy to add Seam to an existing Java EE 5+ application.
+
+The first step to building Seam is to build the version-matrix module:
+
+ cd version-matrix
+ mvn install
+ cd ..
+
+After running an SVN update, it's always a good idea to install the
+version-matrix again.
+
+The version-matrix hosts the dependency management that all Seam modules and
+examples extend. This centralizes all version numbers and artifact-specific
+exclusions to avoid duplication and to establish a sanctioned version
+compatibility matrix (after all, Seam is about integration).
+
+The next step is to build the Seam parent.
+
+ cd parent
+ mvn -N install
+ cd ..
+
+The parent simply extends from the version-matrix and has some POM fragments
+that pertains specifically to the modules (such as test dependencies). If you
+are building a Seam application, you are encouraged to extend from the
+version-matrix, so a parent module is necessary ensure a clean separation from
+that goal.
+
+Now you can build any module you would like, though be aware that a module may
+have a dependency on another module. You can build all of them from the parent.
+
+ cd parent
+ mvn install
+ cd ..
+
+Furthur reading
+---------------
+
+* Read the documentation and FAQ online at http://seamframework.org