You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm@geronimo.apache.org by db...@apache.org on 2004/05/10 22:03:02 UTC
cvs commit: incubator-geronimo BUILDING.txt NOTICE.txt README.txt
dblevins 2004/05/10 13:03:02
Modified: . README.txt
Added: . BUILDING.txt NOTICE.txt
Log:
Renamed existing README.txt to BUILDING.txt. Added a new README.txt and NOTICE.txt file.
Revision Changes Path
1.13 +99 -59 incubator-geronimo/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/incubator-geronimo/README.txt,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- README.txt 10 May 2004 18:08:53 -0000 1.12
+++ README.txt 10 May 2004 20:03:01 -0000 1.13
@@ -1,59 +1,99 @@
-Welcome to Geronimo
-===================
-
-To build me please install Maven from here - version b10 or later.
-
- http://maven.apache.org/
-
-In addition you should have JDK 1.4.x installed with JAVA_HOME
-environment defined to point to this JDK.
-
-In the following examples, '$>' is your prompt, so if you see
-'$>maven', at your prompt, type in 'maven' (without the quotes)
-and then press [enter].
-
-To build Geronimo running all of the unit test cases, compiling
-all the Geronimo sources and installing them in your local maven
-repository:
-
- $>maven
-
-To build and run the server, change into the assembly directory and
-type:
-
- $>maven
- $>cd target
- $>java -jar bin/server.jar org/apache/geronimo/Server
-
-To stop the server use ctrl-C or an equivalent; a proper shutdown
-command will be made available in a future release.
-(See http://wiki.apache.org/geronimo/Running for more information).
-
-To do a clean rebuild of Geronimo type
-
- $>maven rebuild
-
- -or (a slower option)-
-
- $>maven clean
- $>maven
-
-To only build select modules (assumes that depends are installed
-already):
-
- $>maven -Dmodules=common,core
-
-To clean your workspace:
-
- $>maven clean
-
-NOTE: You need to build the server first for this to work due to
- a problem with dependencies & the reactor.
-
-To removal all build generated files:
-
- $>maven clobber
-
-For the HTML website:
-
- $>maven site
+======================================================
+Apache Geronimo milestone build M1 (Apr 28, 2004)
+
+http://wiki.apache.org/geronimo
+http://incubator.apache.org/geronimo
+http://incubator.apache.org/projects/geronimo.html
+------------------------------------------------------
+
+___________________
+Documentation
+===================
+
+ This README serves as five minute overview of Geronimo, but better
+ documentation can be found here:
+
+ - http://wiki.apache.org/geronimo/Deployment
+ - http://wiki.apache.org/geronimo/Running
+
+ Those are wiki pages that will be updated as we collect feedback from
+ this release.
+
+___________________
+Release Notes
+===================
+
+ Please read the RELEASE_NOTES for a complete list of thinigs that are
+ not yet functional. We wrote those up to save you time trying to get
+ things to work we know are not implemented.
+
+___________________
+Installation
+===================
+
+ If you've downloaded and unpacked a binary distrobution of Geronimo,
+ then you are finished with installation. If you downloaded a source
+ distrobution, then see the BUILDING.txt file for more instructions
+ before continuing any further.
+
+___________________
+Geronimo Home
+===================
+
+ The GERONIMO_HOME directory, is the directory where the Geronimo
+ binary was unpacked or the it is the 'target' directory created by
+ Maven from a source distrobution.
+
+ If you unpacked the binary into the directory C:\incubator-geronimo,
+ for example, than this directory is your GERONIMO_HOME directory.
+ The GERONIMO_HOME directory is refered to in various parts of the
+ documentation, so it's good to remeber where it is.
+
+___________________
+Deploying
+===================
+
+ The Geronimo deployment tool is packaged in the executable jar
+ bin/deployer.jar under the GERONIMO_HOME and can be executed like
+ this:
+
+ C:\incubator-geronimo> java -jar bin\deployer.jar --install --module myDataSource.rar
+ C:\incubator-geronimo> java -jar bin\deployer.jar --install --module myEJB.jar
+ C:\incubator-geronimo> java -jar bin\deployer.jar --install --module myWebapp.war
+
+ Notice that the deployer.jar is capable of handling a number of
+ different archive types; rar, war, and ejb jar. At this time ear
+ archives are not supported.
+
+___________________
+Starting
+===================
+
+ The main server class is also packed in an executable jar,
+ bin/server.jar, and can be ran in a way similar to the deploy tool.
+
+ C:\incubator-geronimo> java -jar bin\server.jar org/apache/geronimo/DebugConsole
+
+ I know what you're thinking, "Why does 'bin\server.jar' use
+ back-slashes and 'org/apache/geronimo/DebugConsole' use
+ forward-slashes?" The answer is 'org/apache/geronimo/DebugConsole'
+ is a URI; a unique identifier that Geronimo uses to find the app you
+ want to start. URI's use forward-slashes only, never back-slashes.
+ So, no matter what operating system your on, the URI will always look
+ similar to the one above.
+
+___________________
+Support
+===================
+
+ Any problems with this release can be reported to the Geronimo
+ mailing list or Jira issue tracker.
+
+ Mailing list archive:
+ http://nagoya.apache.org/eyebrowse/SummarizeList?listId=140
+
+ Mailing list subscription:
+ geronimo-dev-subscribe@incubator.apache.org
+
+ Jira:
+ http://issues.apache.org/jira/secure/BrowseProject.jspa?id=10220
1.1 incubator-geronimo/BUILDING.txt
Index: BUILDING.txt
===================================================================
Welcome to Geronimo
===================
To build me please install Maven from here - version b10 or later.
http://maven.apache.org/
In addition you should have JDK 1.4.x installed with JAVA_HOME
environment defined to point to this JDK.
In the following examples, '$>' is your prompt, so if you see
'$>maven', at your prompt, type in 'maven' (without the quotes)
and then press [enter].
To build Geronimo running all of the unit test cases, compiling
all the Geronimo sources and installing them in your local maven
repository:
$>maven
To build and run the server, change into the assembly directory and
type:
$>maven
$>cd target
$>java -jar bin/server.jar org/apache/geronimo/Server
To stop the server use ctrl-C or an equivalent; a proper shutdown
command will be made available in a future release.
(See http://wiki.apache.org/geronimo/Running for more information).
To do a clean rebuild of Geronimo type
$>maven rebuild
-or (a slower option)-
$>maven clean
$>maven
To only build select modules (assumes that depends are installed
already):
$>maven -Dmodules=common,core
To clean your workspace:
$>maven clean
NOTE: You need to build the server first for this to work due to
a problem with dependencies & the reactor.
To removal all build generated files:
$>maven clobber
For the HTML website:
$>maven site
1.1 incubator-geronimo/NOTICE.txt
Index: NOTICE.txt
===================================================================
Apache Geronimo is an effort undergoing incubation at the Apache
Software Foundation. Incubation is required of all newly accepted
projects until a further review indicates that the infrastructure,
communications, and decision making process have stabilized in a
manner consistent with other successful ASF projects. While incubation
status is not necessarily a reflection of the completeness or
stability of the code, it does indicate that the project has yet to be
fully endorsed by the ASF.