You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by vs...@apache.org on 2008/01/10 13:38:46 UTC

svn commit: r610777 - /maven/components/trunk/maven-embedder/README.txt

Author: vsiveton
Date: Thu Jan 10 04:38:45 2008
New Revision: 610777

URL: http://svn.apache.org/viewvc?rev=610777&view=rev
Log:
o merged from r610775 with the correct Maven 2.1.x version

Modified:
    maven/components/trunk/maven-embedder/README.txt

Modified: maven/components/trunk/maven-embedder/README.txt
URL: http://svn.apache.org/viewvc/maven/components/trunk/maven-embedder/README.txt?rev=610777&r1=610776&r2=610777&view=diff
==============================================================================
--- maven/components/trunk/maven-embedder/README.txt (original)
+++ maven/components/trunk/maven-embedder/README.txt Thu Jan 10 04:38:45 2008
@@ -1,23 +1,77 @@
-Installing Maven 2
-==================
 
-The following instructions show how to install Maven 2:
+                          Apache Maven
 
-1) Unpack the archive where you would like to store the binaries, eg:
-  tar zxvf maven-2.0.tar.gz
-or
-  unzip maven-2.0.zip
+  What is it?
+  -----------
 
-2) A directory called "maven-2.0" will be created.
+  Maven is a software project management and comprehension tool. Based on 
+  the concept of a Project Object Model (POM), Maven can manage a project's
+  build, reporting and documentation from a central piece of information.
 
-3) Add the bin directory to your PATH, eg:
-  export PATH=/usr/local/maven-2.0/bin:$PATH
-or
-  set PATH="c:\program files\maven-2.0\bin";%PATH%
+  Documentation
+  -------------
 
-4) Make sure JAVA_HOME is set to the location of your JDK
+  The most up-to-date documentation can be found at http://maven.apache.org/.
 
-5) Run "mvn --version" to verify that it is correctly installed.
+  Release Notes
+  -------------
 
-For more information, please see http://maven.apache.org
+  The full list of changes can be found at http://maven.apache.org/release-notes.html.
 
+  System Requirements
+  -------------------
+
+  JDK:
+    1.4 or above (this is to execute Maven - it still allows you to build against 1.3 
+    and prior JDK's).
+  Memory:
+    No minimum requirement.
+  Disk:
+    No minimum requirement. Approximately 100MB will be used for your local repository,
+    however this will vary depending on usage and can be removed and redownloaded at
+    any time.
+  Operating System:
+    No minimum requirement. On Windows, Windows NT and above or Cygwin is required for
+    the startup scripts. Tested on Windows XP, Fedora Core and Mac OS X.
+
+  Installing Maven
+  ----------------
+
+  1) Unpack the archive where you would like to store the binaries, eg:
+
+    Unix-based Operating Systems (Linux, Solaris and Mac OS X)
+      tar zxvf apache-maven-2.1.x.tar.gz
+    Windows 2000/XP
+      unzip apache-maven-2.1.x.zip
+
+  2) A directory called "apache-maven-2.1.x" will be created.
+
+  3) Add the bin directory to your PATH, eg:
+
+    Unix-based Operating Systems (Linux, Solaris and Mac OS X)
+      export PATH=/usr/local/apache-maven-2.1.x/bin:$PATH
+    Windows 2000/XP
+      set PATH="c:\program files\apache-maven-2.1.x\bin";%PATH%
+
+  4) Make sure JAVA_HOME is set to the location of your JDK
+
+  5) Run "mvn --version" to verify that it is correctly installed.
+
+  For complete documentation, see http://maven.apache.org/download.html#Installation
+
+  Licensing
+  ---------
+
+  Please see the file called LICENSE.TXT
+
+  Maven URLS
+  ----------
+
+  Home Page:          http://maven.apache.org/
+  Downloads:          http://maven.apache.org/downloads.html
+  Release Notes:      http://maven.apache.org/release-notes.html
+  Mailing Lists:      http://maven.apache.org/mail-lists.html
+  Source Code:        http://svn.apache.org/repos/asf/maven/
+  Issue Tracking:     http://jira.codehaus.org/browse/MNG
+  Wiki:               http://docs.codehaus.org/display/MAVENUSER/
+  Available Plugins:  http://maven.apache.org/plugins/index.html