Author: rgardler
Date: Mon Jan 30 11:32:20 2012
New Revision: 1237606
URL: http://svn.apache.org/viewvc?rev=1237606&view=rev
Log:
add a note aboute seeds and templates, plus add a note about how to deploy a
specific widget
Modified:
incubator/wookie/trunk/widgets/readme.txt
Modified: incubator/wookie/trunk/widgets/readme.txt
URL:
http://svn.apache.org/viewvc/incubator/wookie/trunk/widgets/readme.txt?rev=1237606&r1=1237605&r2=1237606&view=diff
==============================================================================
--- incubator/wookie/trunk/widgets/readme.txt (original)
+++ incubator/wookie/trunk/widgets/readme.txt Mon Jan 30 11:32:20 2012
@@ -3,6 +3,23 @@ This directory contains widget sourcecod
Create a widget
===============
+There are three ways to create widgets, the first is to do it all by
+hand. The second is to use a seed widget to provide the basic
+structure of your widget and then edit that. The third is to use out
+templating system that is designed to allow you to build widgets
+without knowing much of how widgets are structured.
+
+The easiest to get started with, if you know HTML and Javascript, is
+probably to use the seed widgets. The templates system allows much
+more reuse between widgets but brings with it a new set of rules and
+configurations to learn.
+
+This document describes using seeds to build widgets. To use the
+templates see WOOKIE_HOME/widgets/template/readme.txt
+
+Using Seeds to Create Widgets
+=============================
+
To create a widget:
ant seed-widget
@@ -40,4 +57,11 @@ ant deploy-widget
You will be asked for the name of the widget you wish to build. this name
should be the
name of the folder containing the widget.
-
\ No newline at end of file
+
+Supplying the widget name
+=========================
+
+It can become tiresome having to enter the widget name repeatedly during the
development cycle.
+For this reason you can supply it in the command, for example;
+
+ant deploy-widget -Dwidget.shortname=FooWidget
