X-Git-Url: http://wamblee.org/gitweb/?a=blobdiff_plain;f=README.txt;h=26f0a2ffc33711c9c2e9ff0cc35a7cea3ba9fffd;hb=5d9e90515b97fb675099a67c01e1d6b8782ba3fa;hp=89685b67a5508472646f2067b6426ba7a6c22a8d;hpb=a7678c5a33f104e42b05b100964755a51a297b56;p=utils

diff --git a/README.txt b/README.txt
index 89685b67..26f0a2ff 100644
--- a/README.txt
+++ b/README.txt
@@ -1,6 +1,41 @@
-This project using maven2. Since maven is all about conventions, see the 
-maven site http://maven.apache.org for information on how to build this project.
+Support utilities for enterprise development
+============================================
 
+* support: Base (non-Java EE) support
+* system:  An IOC framework experiment. This should be flexible enough as a basis for 
+  a CDI implementation. It currently offers only a programmatic API and does not use
+  annotations.  
+* hibernate-jpa: Hibernate JPA dependencies
+* security: Security support utlities (user management and authorization)
+* test: Test support for JEE testing. In particular, junit testing with an inmemory or
+  external database and support for JPA testing with several JPA providers. 
+  
+
+To be removed from this project (currently skipped from the release)
+====================================================================
+
+* socketproxy: An old socketproxy. To be removed from the utilities
+* mythtv: An application for exposing mythtv recordings in a useful directory structure
+  This will be removed from the utilities
+
+To be added to this project
+===========================
+* utilities for CDI
+* wicket utilities. 
+
+Building
+========
+
+You need maven2 and java 6 
+
+By default eclipselink is used as persistence provider. 
+Use mvn -Phibernate,!eclipselink (escape the ! if needed) to build with hibernate as
+persistence provider. 
+
+Releasing
+=========
+
+Trigger release settings by building with -Dwamblee.release=true
+This will skip some projects that are not to be released. 
 
-You must use a java 5 compiler, jdk 1.4.* or earlier will not work.