summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorTommy Reynolds <Tommy.Reynolds@MegaCoder.com>2005-05-11 16:08:57 +0000
committerTommy Reynolds <Tommy.Reynolds@MegaCoder.com>2005-05-11 16:08:57 +0000
commitef0570455d1bea9be71c32f22efbb9913b69952d (patch)
tree1e511af292f044dc71f2ada8984c6e91b356d20e /README
parent2f162717d2168ca09d071c781ae4d007cc445330 (diff)
downloadfedora-doc-utils-ef0570455d1bea9be71c32f22efbb9913b69952d.tar.gz
fedora-doc-utils-ef0570455d1bea9be71c32f22efbb9913b69952d.tar.xz
fedora-doc-utils-ef0570455d1bea9be71c32f22efbb9913b69952d.zip
Updated to reflect current CVS usage strategy.
Diffstat (limited to 'README')
-rw-r--r--README56
1 files changed, 40 insertions, 16 deletions
diff --git a/README b/README
index 4bdfc0a..b32f1aa 100644
--- a/README
+++ b/README
@@ -1,16 +1,40 @@
-This module contains the docs for the Docs Project, part of the
-Fedora Project. Except for the Installation Guide and guides on how
-to participate such as the Developer's Guide, all
-docs must be tutorials written in DocBook XML article format using
-the template in the example-tutorial directory. Each tutorial
-*must* be in its own directory. No XML files should be in the
-root directory except for files shared by all documents such
-legalnotice.xml, which must be included in all docs so that the
-FDL is used for all docs.
-
-The common/ directory contains DocBook XML files shared by two or more
-guides.
-
-Questions? Email fedora-docs-list@redhat.com.
-
-test change
+This repository contains the source files for the Docs Project, part
+of the Fedora Project. Except for the Installation Guide and guides
+on how to participate such as the Developer's Guide, all docs must be
+tutorials written in DocBook XML article format using the template in
+the example-tutorial directory. Each tutorial *must* be in its own
+directory. No XML files should be in the root directory.
+
+Four modules comprise the minimal set that must be obtained to view
+or edit any document:
+
+ common/
+
+ DocBook XML files shared by multiple guides.
+
+ css/
+
+ Cascading Style Sheets (CSS) that control the "look
+ and feel" used to render documents in HTML format.
+
+ stylesheet-images/
+
+ Graphics resources used to render documents in both
+ PDF and HTML format.
+
+ xsl/
+
+ XSLT style sheets used to render the document texts,
+ which are written in DocBook XML, into either HTML or
+ PDF format.
+
+Notice:
+
+ PDF generation is currently extremely fragile and may not
+ work at all. We are investigating this.
+
+Any Questions?
+
+ Email fedora-docs-list@redhat.com.
+
+[end of document]