Author: dan.j.allen
Date: 2009-10-22 18:27:23 -0400 (Thu, 22 Oct 2009)
New Revision: 4230
Modified:
build/trunk/dist/readme.txt
Log:
borrow readme.txt format from Hibernate Validator to make it look more professional
Modified: build/trunk/dist/readme.txt
===================================================================
--- build/trunk/dist/readme.txt 2009-10-22 21:52:32 UTC (rev 4229)
+++ build/trunk/dist/readme.txt 2009-10-22 22:27:23 UTC (rev 4230)
@@ -1,29 +1,64 @@
-Weld
-------------
-Java Contexts and Dependency Injection for the Java EE platform (JSR-299) is a
-new Java standard for dependency injection and contextual lifecycle management.
-Weld is the reference implementation of JSR-299.
+ Weld
-This distribution, as a whole, is licensed under the terms of the Apache
-License, Version 2.0 (see apl.txt).
+ What is it?
+ ============
-This distribution consists of:
+ Weld is the reference implementation of JSR-299: Java Contents and Dependency
+ Injection for the Java EE platform (CDI). JSR-299 is the new Java standard for
+ dependency injection and contextual life cycle management.
-doc/
- -- The Reference guide, take a look at doc/en-US/html/index.html for getting
- started using Weld and the facilities offered by JSR-299.
-
-examples/
- -- The Weld examples, the examples are described in more detail in the
- reference guide
+ Status
+ =======
+
+ This is a preproduction release of Weld.
+
+ System requirements
+ ===================
+
+ JDK 5.0 or above.
+
+ Contents of distribution
+ ========================
+
+ doc/
+
+ API Docs and reference guide. Open doc/en-US/html/index.html in your
+ browser for instructions on how to get started using Weld and the
+ facilities offered by JSR-299.
-jboss-as/
- -- Installer for JBoss AS, change into this directory, and run ant update
- There are more details in the reference guide
+ examples/
-lib/
- -- Libraries, for building the examples
-
-lib/weld
- -- Weld binary, source and javadoc jars
+ The Weld examples, the examples are described in more detail in the
+ reference guide
+
+ jboss-as/
+
+ Installer for JBoss AS, change into this directory, and run ant update
+ There are more details in the reference guide
+
+ lib/
+
+ Libraries, for building the examples
+
+ lib/weld
+
+ Weld binary, source and javadoc jars
+
+ Licensing
+ =========
+
+ This distribution, as a whole, is licensed under the terms of the Apache
+ License, Version 2.0 (see apl.txt).
+
+ Weld URLs
+ =========
+
+ Home Page:
http://seamframework.org/Weld
+ Downloads:
http://seamframework.org/Download/SeamDownloads#H-WeldAndJSR299TCKReleases
+ Mailing Lists:
https://lists.jboss.org/mailman/listinfo/weld-dev
+ Source Code:
http://anonsvn.jboss.org/repos/weld
+ Issue Tracking:
https://jira.jboss.org/jira/browse/WELD (core)
+
https://jira.jboss.org/jira/browse/WELDX (extensions)
+
https://jira.jboss.org/jira/browse/WELDINT (JBoss AS integration)
+