aboutsummaryrefslogtreecommitdiffstats
path: root/doc/plan/README
diff options
context:
space:
mode:
Diffstat (limited to 'doc/plan/README')
-rw-r--r--doc/plan/README36
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/plan/README b/doc/plan/README
new file mode 100644
index 000000000..c5a3d00ae
--- /dev/null
+++ b/doc/plan/README
@@ -0,0 +1,36 @@
+Epiphany Plan README
+
+
+ITEM STATUS INFORMATION
+=======================
+
+Each <item> needs to have a status assigned; possible values are:
+
+ orphan
+ pending
+ delayed
+ designed
+ implementing
+ completed
+
+
+HTML TRANSFORMATION
+===================
+
+The XSLT stylesheet shipped with the plan, plan2table.xsl, will
+transform the plan's XML into a nice HTML table by using:
+
+ xsltproc -o plan.html plan2table.xsl plan.xml
+
+
+VALIDATION
+==========
+
+There's a DTD associated with the Epiphany plan, ephyplan.dtd.
+To prevent typos, you could validate the plan before commiting changes
+to CVS by using:
+
+ xmllint --noout --valid plan.xml
+
+You could also simply run "make" in this directory, which will
+validate the xml input file first, and then transform it to html.