maven/maven-embedder
Jason van Zyl c224eeefb2 o put the embedder documentation in the normal site
git-svn-id: https://svn.apache.org/repos/asf/maven/components/trunk@648507 13f79535-47bb-0310-9956-ffa450edef68
2008-04-16 04:36:21 +00:00
..
src o put the embedder documentation in the normal site 2008-04-16 04:36:21 +00:00
LICENSE.txt o moving over the stuff required for the CLI here 2007-03-04 00:48:55 +00:00
NOTICE.txt o reflected the notice from the archive 2008-01-10 12:31:58 +00:00
README.txt o merged from r611015 (MNG-3360: Added the documentation in the Maven release) 2008-01-11 02:02:32 +00:00
pom.xml o version is now stated in the parent POM 2008-04-15 15:55:34 +00:00

README.txt

                          Apache Maven

  What is it?
  -----------

  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.

  Documentation
  -------------

  The documentation available as of the date of this release is included in
  HTML format in the docs/ directory.
  The most up-to-date documentation can be found at http://maven.apache.org/.

  Release Notes
  -------------

  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