svn commit: r1198106 - in /incubator/airavata/trunk: INSTALL README

[sm...@apache.org]

Author: smarru
Date: Sat Nov  5 23:03:36 2011
New Revision: 1198106

URL: http://svn.apache.org/viewvc?rev=1198106&view=rev
Log:
Updating instructions before the branch. 

Modified:
    incubator/airavata/trunk/INSTALL
    incubator/airavata/trunk/README

Modified: incubator/airavata/trunk/INSTALL
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/INSTALL?rev=1198106&r1=1198105&r2=1198106&view=diff
==============================================================================
--- incubator/airavata/trunk/INSTALL (original)
+++ incubator/airavata/trunk/INSTALL Sat Nov  5 23:03:36 2011
@@ -1,27 +1,24 @@
-Installing  Apache Airavata 0.0.1-SNAPSHOT
+Installing  Apache Airavata 0.1-INCUBATING
 ------------------------------------------------
 
-Build Apache Airavata from Source
-------------------------------
-
 Prerequisites
 -------------
 Java 1.5
 Maven (tested on v 3.0.2)
 
+Build Apache Airavata from Source
+---------------------------------
+* Unzip/untar the source file or check out from svn.
+* cd to project folder and type
+* mvn clean install -Dmaven.test.skip=true
+* The compressed binary distribution is created at <PROJECT DIR>/distribution/target
 
-1. Check out the code from SVN.
-
-
-2. Go to project folder and type
-
-        mvn clean install -Dmaven.test.skip=true
-
-
-3. The binary distribution is located at
-
-        <PROJECT DIR>/distribution/target
+Running Tests
+-------------
+Once the binary is unzipped, instructions to run the tests should be followed from README
 
+Advanced Configuration
+=======================
 
 Configuring GFac Service
 ------------------------
@@ -167,6 +164,5 @@ property axis2.repository to the correct
 
 Run Samples
 -----------
-
-To Run samples go to <extracted location>/samples and refer the sample level READM files.
+To Run samples go to <extracted location>/samples and refer the sample level README files.
 

Modified: incubator/airavata/trunk/README
URL: http://svn.apache.org/viewvc/incubator/airavata/trunk/README?rev=1198106&r1=1198105&r2=1198106&view=diff
==============================================================================
--- incubator/airavata/trunk/README (original)
+++ incubator/airavata/trunk/README Sat Nov  5 23:03:36 2011
@@ -23,38 +23,36 @@ manner consistent with other successful 
 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.
 
-New Features In This Release
-----------------------------
+Release Notes
+=============
+0.1-INCUBATNG is the first release of Airavata. This release focuses on cleaning up
+of donated code, packaging all components into modular architecture, documentation, 
+and removal of non-compatible license dependencies. For detailes tasks list, please
+see RELEASE_NOTES.
 
 
-Key Features
-------------
-
-
-Issues Fixed in This Release
-----------------------------
-
-
-Installation & Running
-----------------------
-
-For installation and further instructions refer www.airavata.org - Documentation section in right hand panel... That
-contains proper documentation with screenshots.
-
+Building from source
+====================
+For brief installation instructions, see INSTALL
+For detailed installation and further instructions refer www.airavata.org - Documentation 
+section in right hand panel. Step by step with proper documentation and screenshots is
+provided.
 
 Known Issues in This Release
-----------------------------
-
-
-Including External Dependencies
---------------------------------
+============================
+This is the base release and is focused on a good foundation and less on features. This 
+version is not recommended for production usage.
 
 
-WS-Messenger Binary Distribution Directory Structure
---------------------------------------------
+Airavata Binary Distribution Directory Structure
+================================================
 
     AIRAVATA_HOME
         |-- bin <folder>
+            |--airavata-server.sh
+            |--jackrabbit-server.sh
+            |--setenv.sh
+            |--xbaya-gui.sh
         |-- samples <folder>
         |-- gui <folder>
         |-- lib <folder>
@@ -65,17 +63,28 @@ WS-Messenger Binary Distribution Directo
         |       -- services <folder>
         |   |-- bin <folder>
                 |-- database_scripts
-        |-- LICENSE.txt <file>
-        |-- README.txt <file>
-        |-- INSTALL.txt <file>
-
+        |-- DISCLAIMER <file>
+        |-- NOTICE <file>
+        |-- LICENSE <file>
+        |-- README <file>
+        |-- INSTALL <file>
+
+
+How to test and run samples
+===========================
+* If you built Airavata from source, and if you see "BUILD SUCCESS", then the test cases should have passes.
+* The test cases are beyond unit level, they startup embedded services and run through basic workflow use cases.
+* To walk through Airavata features, follow "Airavata in Five Minutes" tutorial at http://incubator.apache.org/airavata/documentation/system/airavata-in-5-minutes.html
+* For intermediate level Airavata features, follow "Airavata in Ten Minutes" tutorial at http://incubator.apache.org/airavata/documentation/system/airavata-in-10-minutes.html 
+* For advanced use cases, please contact mailing lists - http://incubator.apache.org/airavata/community/mailing-lists.html
 
+Description of Directory Structure
+==================================
     - bin
       This contains all the executable scripts to run required applications in Airavata distribution.
         Ex: This contains scripts to run XBaya GUI Application, Airavata Server (Axis2 server with Airavata services which
             include messageBroker and messageBox with GFac Axis2 services), Jackrabbit executables to run.
     - samples
-
       This contains all the system wide samples provided in Airavata distribution. All the sample are having its README file
       So users have to refer each readme file before running each sample.
 
@@ -104,8 +113,8 @@ WS-Messenger Binary Distribution Directo
     - standalone-server - bin - database_scripts
       Contains the database scripts which are used to create tables for messagebox and messagebroker services
 
-    - README.txt
+    - README
       This document.
 
-    - INSTALL.txt
+    - INSTALL
           This document will contain information on installing Apache-Airavata.