You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by st...@apache.org on 2004/10/28 20:56:14 UTC
svn commit: rev 55883 - incubator/beehive/branches/v1/alpha/docs
Author: steveh
Date: Thu Oct 28 11:56:12 2004
New Revision: 55883
Added:
incubator/beehive/branches/v1/alpha/docs/
incubator/beehive/branches/v1/alpha/docs/WELCOME.html (contents, props changed)
Log:
First draft of a "read me first" topic for the v1-alpha dist. Users should read this topic first when they unzip the dist.
Added: incubator/beehive/branches/v1/alpha/docs/WELCOME.html
==============================================================================
--- (empty file)
+++ incubator/beehive/branches/v1/alpha/docs/WELCOME.html Thu Oct 28 11:56:12 2004
@@ -0,0 +1,94 @@
+<html>
+ <head>
+ <title>Welcome to Apache Beehive</title>
+ </head>
+ <body>
+ <h1>Beehive v1-alpha Distribution</h1>
+
+<h2>1) Introduction</h2>
+<p>This document describes how to start working with the
+v1-alpha distribution of Apache Beehive.</p>
+
+<h2>2) What is Apache Beehive?</h2>
+
+<p>Apache Beehive a Java-based effort to simply the development of
+web applications, web services, and controls.</p>
+
+<p>Apache Beehive uses metadata annotations, new in Java 5,
+that allow you to set properties on Java classes and methods,
+to simply the development process. </p>
+
+<h2>3) Distribution Directories</h2>
+
+<p>The table below describes the contents of the Beehive v1-alpha Destribution</p>
+
+<table border="1">
+ <tbody>
+ <tr>
+ <th align="left">Directory</th><th align="left">Description</th>
+ </tr>
+ <tr>
+ <td>apache-beehive-incubating-alpha-xxx</td><td>The top-level folder for the distribtion</td>
+ </tr>
+ <tr>
+ <td> ant</td><td>Contains Ant build files for building Beehive apps and deploying them to Tomcat</td>
+ </tr>
+ <tr>
+ <td> lib</td><td>Contains the JAR resources (both runtime and compile-time) for Beehive apps</td>
+ </tr>
+ <tr>
+ <td> common</td><td>JAR archives of Beehive's dependencies</td>
+ </tr>
+ <tr>
+ <td> controls</td><td>JAR resources for Beehive Controls</td>
+ </tr>
+ <tr>
+ <td> netui</td><td>Resources for Beehive Page Flows, including compile-time and runtime JARS and the <netui> JSP tag library</td>
+ </tr>
+ <tr>
+ <td> wsm</td><td>Resources for Beehive Web Services</td>
+ </tr>
+ <tr>
+ <td> samples</td><td>Code samples and application templates</td>
+ </tr>
+ <tr>
+ <td> controls-blank</td><td>A Control application template. Use this template as a starting point for Control development.</td>
+ </tr>
+ <tr>
+ <td> netui-blank</td><td>A Page Flow application template. Use this template as a starting point for Page Flow development.</td>
+ </tr>
+ <tr>
+ <td> PetStroreDashboard</td><td>A Web Service application that provides an administrator's view on the petstoreWeb web application.</td>
+ </tr>
+ <tr>
+ <td> petstoreWeb</td><td>A web application composed of Beehive Page Flows and Controls.</td>
+ </tr>
+ </tbody>
+</table>
+
+<h2>4) Docs and Samples</h2>
+
+<p>The user's guide and reference documentation is available online at <a href="http://incubator.apache.org/beehive">http://incubator.apache.org/beehive</a> or locally in the directory <code>apache-beehive-incubating-alpha-xxx/docs/</code>
+
+<p>The petstoreWeb sample demonstrates how Beehive Page Flows and Controls work together. To run the sample follow the instructions at <code>apache-beehive-incubating-alpha-xxx/samples/petstoreWeb/README</code>.</p>
+
+<p>The PetStroreDashboard sample demonstrates the capabilities of Beehive Web Services. To run the sample, follow the instructions at [todo].</p>
+
+<h2>5) Setup</h2>
+
+<p>To develop Beehive applications with distribution v1-alpha, you must have the following installed on your machine.</p>
+
+<ul>
+ <li>J2SE 5.0</li>
+ <li>Ant 1.6.2</li>
+</ul>
+
+To run the petstoreWeb and PetStoreDashboard samples, you must have <code>Tomcat 5.x</code> installed.
+
+<h2>6) Developing with Apache Beehive</h2>
+
+<p> how to build a simple Beehive enabled webapp from the blank app template... [todo]</p>
+
+<p> how to build a simple control with the template provided....[todo]</p>
+ </body>
+</html>