svn commit: r1136901 - /incubator/rave/trunk/rave-portal/src/main/dist/README

[mp...@apache.org]

Author: mpierce
Date: Fri Jun 17 14:52:27 2011
New Revision: 1136901

URL: http://svn.apache.org/viewvc?rev=1136901&view=rev
Log:
RAVE-64 This is a README for the binary demo distribution.


Modified:
    incubator/rave/trunk/rave-portal/src/main/dist/README

Modified: incubator/rave/trunk/rave-portal/src/main/dist/README
URL: http://svn.apache.org/viewvc/incubator/rave/trunk/rave-portal/src/main/dist/README?rev=1136901&r1=1136900&r2=1136901&view=diff
==============================================================================
--- incubator/rave/trunk/rave-portal/src/main/dist/README (original)
+++ incubator/rave/trunk/rave-portal/src/main/dist/README Fri Jun 17 14:52:27 2011
@@ -1,10 +1,37 @@
 Apache Rave Demo - README
 
-TODO:
-- about
-- minimum requirements (Java 6+)
-- running tomcat
-- browser access
-- login accounts
-- known issues
-- links/references
\ No newline at end of file
+ABOUT
+
+Apache Rave is a new web and social mashup engine. Its goal is to provide an out-of-the-box as well as an extendible lightweight Java platform to host, serve and aggregate (Open)Social Gadgets and services through a highly customizable and Web 2.0 friendly front-end. For more information, see http://incubator.apache.org/rave/
+
+The binary release includes Tomcat 6 and two WAR files: Apache Rave and Apache Shindig 3.0.0-beta2.  This is a self-contained release: you should be able to run Rave with no additional downloads.
+
+MINIMUM REQUIREMENTS
+
+The binary distribution (.tar.gz or .zip) must be unpacked with the appropriate tool. The minimum requirement for running the binary release is Java SDK 6+.  Rave should work on standard operating systems (Linux and Unix flavors including Mac OS X; Windows Vista and 7).  
+
+RUNNING TOMCAT
+
+From the unpacked RAVE distribution directory, execute the startup script from Rave's bin subdirectory, either startup.sh (linux/unix/osx) or startup.bat (windows). To shut down tomcat, run either shutdown.sh or shutdown.bat, also located in Rave's bin subdirectory. Tomcat logging and error messages are in logs/catalina.out. Unix users can follow output with tail -f logs/catalina.out.
+
+BROWSER ACCESS
+
+After starting tomcat, point your browser to http://localhost:8080/portal.  There are currently no known browser restrictions.
+
+LOGIN ACCOUNTS
+
+Rave comes with the following built-in accounts (username and password are the same): canonical, john.doe, jane.doe, george.doe, mario.rossi, and maija.m.  Rave also supports OpenID login to one account: http://rave2011.myopenid.com.  The OpenID password is "rave2011".  
+
+KNOWN ISSUES
+
+This is a very early release of Rave that the developers hope will prompt greater participation from the Apache community.  Currently there is no way to administer accounts or add arbitrary gadgets or widgets through the Web interface.  For a comprehensive set of developement issues, see https://issues.apache.org/jira/browse/rave.  Rave has also not been extensively tested on a range of operating systems and browsers.
+
+
+LINKS/REFERENCES
+
+Apache Rave Incubator Web Site: http://incubator.apache.org/rave/
+Apache Rave Source Code (SVN Browse): http://svn.apache.org/viewvc/incubator/rave/
+Apache Rave Issue Tracker: https://issues.apache.org/jira/browse/rave
+Apache Rave Mailing Lists: http://incubator.apache.org/rave/mailing-lists.html
+Apache Incubator (General Information): http://incubator.apache.org/
+