Skip to content

Commit 8a03d0f

Browse files
committed
Updated read me
added info to the read me about where to get dita and how to generate the handbook… not complete yet…
1 parent ba73ffa commit 8a03d0f

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,13 @@
11
CSGradHandbook
22
==============
33

4-
DITA (XML) files for the CS Graduate Handboook
4+
DITA (XML) files for the CS Graduate Handboook. The files are written in DITA and "compiled" using the DITA Open Toolkit. Darwin Information Typing Architecture (DITA) is an XML standard for generating technical documentation.
5+
6+
We generate the PDF, Web and ePub versions of the graduate handbook using the DITA-OT.
7+
8+
* DITA spec <http://docs.oasis-open.org/dita/v1.2/os/spec/DITA1.2-spec.html>
9+
* DITA Open Toolkit (DITA-OT) <https://github.com/dita-ot/dita-ot/>
10+
* There is an easy to install package for Windows and OS-X available here <http://dita-ot.github.io>.
11+
12+
Follow the instrutions in the <http://dita-ot.github.io> to install and run the OT to generate the handbook.
13+

0 commit comments

Comments
 (0)