You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@commons.apache.org by qu...@apache.org on 2003/03/10 05:59:49 UTC
cvs commit: jakarta-commons-sandbox/email README.txt
quintonm 2003/03/09 20:59:49
Modified: email README.txt
Log:
Updated to contain the correct build instructions
Revision Changes Path
1.2 +15 -16 jakarta-commons-sandbox/email/README.txt
Index: README.txt
===================================================================
RCS file: /home/cvs/jakarta-commons-sandbox/email/README.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- README.txt 9 Aug 2001 22:50:48 -0000 1.1
+++ README.txt 10 Mar 2003 04:59:48 -0000 1.2
@@ -1,25 +1,24 @@
Email Sandbox
------------
-What can you do :
+Getting started:
-1) BUILD
- Define your ${lib.repo} paths to the jar files:
- Activation, JavaMail, and Commons-Util
- in the build.properties file.
-
- To build, you need ant installed ;) and just type 'ant'
- as the default target will build the jar.
+1) Build the jar file
- There are also a few other targets like 'javadoc'. Look
- in build.xml
+ If you have the source distribution you will need to build the jar file
+ using Maven. For instructions on downloading and installing Maven see
+ http://jakarta.apache.org/turbine/maven/start/index.html.
-2) USE
+ To build execute the command 'maven'. The jar file will be built in the
+ target directory.
- To use the Commons Email package (CEP), build a commons-email.jar file,
- import the desired classes from org.apache.commons.email and
- compile your code with commons-email.jar in the CLASSPATH.
+2) Generate the documentation
-3) SOURCE
+ Run the 'maven site:generate' command. The documentation will be written
+ to the target/docs directory.
+
+3) Use
+
+ Simply include the jar file built in step #1 in your classpath. Import the
+ classes that you want to use and you are ready to go!
- Source is in src/java.
---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org