summaryrefslogtreecommitdiff
path: root/doc/hackersguide/README
diff options
context:
space:
mode:
Diffstat (limited to 'doc/hackersguide/README')
-rw-r--r--doc/hackersguide/README29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/hackersguide/README b/doc/hackersguide/README
new file mode 100644
index 000000000..6e99bc535
--- /dev/null
+++ b/doc/hackersguide/README
@@ -0,0 +1,29 @@
+
+ ----------------------
+ xine
+ ----------------------
+
+ a free video player
+
+
+This directory contains the xine hacker's guide.
+
+
+The xine hacker's guide is written in docbook/sgml 4.1.
+You can learn more about docbook at
+
+http://www.oasis-open.org/docbook/documentation/reference/html/docbook.html
+
+
+To use docbook - for example to compile the sgml files into html - you
+will need the DocBook DTD itself as well as the following tools: dsssl
+(Modular DocBook Stylesheets), jade (SGML parser toolkit and dsssl
+engine) and sp (toolkit for sgml parsing), or replacements for those.
+
+If you want to generate TeX output (needed for postscript or pdf
+generation) you will also need jadetex (backend for TeX) and an
+installed TeX system (for example teTeX).
+
+---
+version of this file:
+ $Id: README,v 1.1 2001/10/09 18:20:23 heikos Exp $