summaryrefslogtreecommitdiffstats
path: root/docs/readme-docs-module.html
diff options
context:
space:
mode:
authorwisberg <wisberg>2002-12-16 17:58:19 +0000
committerwisberg <wisberg>2002-12-16 17:58:19 +0000
commitd842c4f1139629c1f062b74ba818d233b2c31043 (patch)
tree842d3871620bc0eb60edcd95e55804d67e0f61fa /docs/readme-docs-module.html
parent3ce247199704eae6b2c92c6e38c69584e3250c52 (diff)
downloadaspectj-d842c4f1139629c1f062b74ba818d233b2c31043.tar.gz
aspectj-d842c4f1139629c1f062b74ba818d233b2c31043.zip
initial version
Diffstat (limited to 'docs/readme-docs-module.html')
-rw-r--r--docs/readme-docs-module.html32
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/readme-docs-module.html b/docs/readme-docs-module.html
new file mode 100644
index 000000000..0bd11ae2b
--- /dev/null
+++ b/docs/readme-docs-module.html
@@ -0,0 +1,32 @@
+<html>
+<title>AspectJ docs</title>
+<body>
+<h1>AspectJ docs</h1>
+
+The AspectJ docs include native sources (html and word files)
+and XML DocBook files used to produce the FAQ and guides.
+The <a href="dist">dist</a> directory contains the native files
+as they are delivered with the distribution, and the
+docbook directories
+ <a href="faq">faq</a>,
+ <a href="progGuideDB">progGuideDB</a>, and
+ <a href="devGuideDB">devGuideDB</a>
+contain sources for the FAQ and the Programming and Development Guides,
+generated using the Ant <a href="build.xml">build.xml</a> script.
+
+<p>
+<u>Build</u>: The script uses a taskdefs defined in ../lib/build/build.jar
+to generate the installers, and others to do misc. text-conversion.
+Dependencies outside this directory:
+<ul>
+<li>.xml files refer to their docbook dtds using relative
+ path, for the moment ../../lib/docbook/...
+ <li>
+<li>When building docbook, uses ../lib/saxon libraries.
+ <li>
+<li>When building installer, using ../lib/build/build.jar
+ and the ../build/installer-resources.
+ <li>
+</ul>
+</body>
+</html>