vinayc 2003/08/28 10:55:34 Modified: . README.txt Log: New structure because of mavenizing and modularizing Revision Changes Path 1.2 +74 -12 incubator-altrmi/README.txt Index: README.txt =================================================================== RCS file: /home/cvs/incubator-altrmi/README.txt,v retrieving revision 1.1 retrieving revision 1.2 diff -u -r1.1 -r1.2 --- README.txt 16 Feb 2003 15:56:54 -0000 1.1 +++ README.txt 28 Aug 2003 17:55:34 -0000 1.2 @@ -1,18 +1,80 @@ - Incubator's Altrmi - ------------------ +PROJECT: AltRMI +==================================================================== -Altrmi +1. DESCRIPTION: +--------------- +This directory contains the AltRMI sources and all resources required to build AltRMI library. +Structure and build procedures are described below. -Getting Started: ----------------- +2. STRUCTURE: +------------- -If you downloaded a source release of the component then you -will need to build the component. Directions for building the -component are located in BUILDING.txt +incubator-altrmi + | + +-- common common interfaces and command objects marshalled across the wire + +-- client + +-- client-api client API interfaces and classes + +-- client-impl client Implementation + +-- server + +-- server-api server API interfaces and classes + +-- server-impl server Implementation + +-- tools Tools like Proxy Generator, Ant tasks, JavaCompiler + +-- transports + +-- jms JMS based transport using messenger (http://jakarta.apache.org/commons/sandbox/messenger) + +-- direct Transport within the same VM + +-- callback Callback enabling transport + +-- integrationtests Integration test cases + +-- xdocs Main Project Documentation + +Each module comes with its own unit tests as well as module specific documentation. -If you downloaded a binary release, or a release with both binary -and source then it is recomended you look over the documentation -in docs/index.html - and then look into the examples/ directory -for examples of the component in action. +3. BUILD PROCEDURE : +-------------------- + +The AltRMI project can be built using : + Ant(http://ant.apache.org) + (or) + Maven project management tool(http://maven.apache.org). + + 3.1 BUILD PROCEDURE USING MAVEN : +------------------------------------ +The default goal builds AltRMI under the default /target/ folder. + + $ maven + +The 'site' goal aggregates the sources from across the main AltRMI sub-projects +to build a consolidated project presentation. The goal should be invoked from the +root altrmi directory. + + $ maven site-all + + To clean up all the mess use 'clean-all' goal + + $ maven clean-all + + 3.1 BUILD PROCEDURE USING ANT : (todo) +------------------------------------------ +The default goal builds AltRMI under the default /target/ folder. + + $ ant + +The 'test' task runs the unit tests for each module as well as integration tests +consolidated under the integrationtests module. + + $ ant test + +Current the project related documentation is built using Maven. + + +FURTHER QUERIES : +------------------ +For additional information please check the documentation and also use the +Incubator Mailing list (subscription details in the doc). + +Finally, please keep in mind that while AltRMI is nearing completion and +readiness for a first release, it should be considered as beta software as +APIs are changing, and documentation is evolving. + +vinayc 27 August 2003
--------------------------------------------------------------------- To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, e-mail: [EMAIL PROTECTED]
