Mailing-List: contact cvs-help@avalon.apache.org; run by ezmlm
Precedence: bulk
Reply-To: "Avalon Developers List" <dev@avalon.apache.org>
Date: 14 Jun 2003 15:19:06 -0000
Message-ID: <20030614151906.92165.qmail@icarus.apache.org>
From: leosimons@apache.org
To: avalon-cvs@apache.org
Subject: cvs commit: avalon README.txt

leosimons    2003/06/14 08:19:06

  Modified:    .        README.txt
  Log:
  explain what is in this cvs module.
  
  Revision  Changes    Path
  1.4       +48 -44    avalon/README.txt
  
  Index: README.txt
  ===================================================================
  RCS file: /home/cvs/avalon/README.txt,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -r1.3 -r1.4
  --- README.txt	5 Feb 2003 22:44:28 -0000	1.3
  +++ README.txt	14 Jun 2003 15:19:06 -0000	1.4
  @@ -1,45 +1,49 @@
   
  -                      A  V  A  L  O  N - F R A M E W O R K
  -
  -                                   @version@
  -
  -
  -  What is it?
  -  -----------
  -
  -  It is a set of classes and patterns that support high level server development.
  -
  -  Where is it?
  -  ------------
  -
  -  http://avalon.apache.org/framework/
  -
  -  Runtime Requirements
  -  --------------------
  -  Avalon-Framework requires a Java Runtime Environment, version 1.2 or above.
  -  
  -  Additional functionality is available if the following packages are available:
  -      - JRE 1.4 or higher
  -      - Avalon-Logkit 1.0 or higher
  -      - Log4J 1.2 or higher
  -      - Xerces-J 2.0 or higher
  -
  -  Buildtime Requirements
  -  ----------------------
  -  For building from source, there are some additional requirments:
  -      - Ant 1.5 or above
  -      - Forrest 0.2 or above
  -      - JAVA_HOME to the jdk dir (eg:/usr/bin/jdk1.2 or c:\jdk1.3)
  -      - ANT_HOME set to the ant dir (eg: /opt/ant or c:\ant)
  -      - FORREST_HOME set to the forrest dir (eg: /opt/forrest or c:\forrest)
  -      - ant scripts in the path
  -      - forrest scripts in the path
  -  If the above requirments are all satisfied, you can build Avalon-Framework by
  -  running ant, normally done by typing `ant dist`.
  -
  -  What are the files?
  -  -------------------
  -  README.txt        This file.  It is a general overview.
  -  LICENSE.txt       The Apache Software License 1.1 that covers Avalon.
  -  KEYS              The list of public keys used for releasing Avalon.
  -  build.xml         The ANT build script.
  +=======================================================================
  +            __
  +           /  \    Apache
  +          /    \__________________________________
  +         /  /\  \  \/  /    \ |  |  /   \|   \|  |
  +        /  /  \  \    /  /\  \|  |_|  O  |  \ \  |
  +       /__/    \__\__/__/  \__\_____\__ /|__|\___|
  +
  +
  +                         == Server Framework ==
  +
  +=======================================================================
  +summary:   an effort to create, design, develop and maintain a common
  +           framework and set of components for applications written
  +           using the java language.
  +publisher: Apache Software Foundation
  +website:   http://avalon.apache.org/
  +license:   Please see the LICENSE.txt file
  +=======================================================================
  +
  +This is the main cvs module for the Apache Avalon project. It is
  +organised into several subdirectories containing several subprojects.
  +See the documentation and other resources inside those subdirectories
  +for more information.
  +
  +
  +More documentation?
  +===================
  +Most of our documentation is stored in CVS only in xml format. The HTML-
  +formatted pages that are generated from those xml files are available at
  +our website at
  +
  +    http://avalon.apache.org/
  +
  +
  +Building from source?
  +=====================
  +The avalon buildfiles use a common buildsystem which utilizes maven and
  +forrest. You will need to download and install maven, the
  +maven-forrest-plugin, and the avalon-buildsystem module. After doing so,
  +change into the buildsystem directory and type `maven avalon:info` to
  +get yourself started.
  +
  +
  +Where did the Avalon-Framework subproject go?
  +=============================================
  +Don't worry, it didn't move very far. The framework sources have been
  +relocated to the framework subdirectory.
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: cvs-unsubscribe@avalon.apache.org
For additional commands, e-mail: cvs-help@avalon.apache.org