initial xine hacker's guide stuff

CVS patchset: 778
CVS date: 2001/10/09 18:20:23

3 files changed, 111 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 $
diff --git a/doc/hackersguide/hackersguide.sgml b/doc/hackersguide/hackersguide.sgml
new file mode 100644
index 000000000..a910b1c2b
--- /dev/null
+++ b/doc/hackersguide/hackersguide.sgml
@@ -0,0 +1,34 @@
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
+<!ENTITY intro SYSTEM "intro.sgml">
+]>
+
+<book>
+<bookinfo>
+  <title>The xine hacker's guide</title>
+  <titleabbrev>hackersguide</titleabbrev>
+  <authorgroup>
+    <author><firstname>G&uuml;nter</firstname><surname>Bartsch</surname></author>
+    <author><firstname>Heiko</firstname><surname>Sch&auml;fer</surname></author>
+
+  </authorgroup>
+  <copyright>
+    <year>2001</year>
+    <holder>the xine project team</holder>
+  </copyright>
+  <abstract>
+  <para>
+    This document should help xine hackers to find their way through
+    xine's architecture and source code. It's a pretty free-form document
+    containing a loose collection of articles describing various aspects
+    of xine's internals.
+  </para>
+  </abstract>
+</bookinfo>
+
+
+<chapter id="intro">
+<title>Introduction</title>
+  &intro;
+</chapter>
+
+</book>
diff --git a/doc/hackersguide/intro.sgml b/doc/hackersguide/intro.sgml
new file mode 100644
index 000000000..de9df59c2
--- /dev/null
+++ b/doc/hackersguide/intro.sgml
@@ -0,0 +1,48 @@
+<sect1>
+<title>Where am I ?</title>
+<para>
+You are currently looking at a piece of documentation for xine.
+xine is a free video player. It lives on
+<ulink url="http://xine.sf.net">http://xine.sf.net</ulink>.
+</para>
+</sect1>
+
+<sect1>
+<title>What does this text do ?</title>
+<para>
+This document should help xine hackers to find their way through
+xine's architecture and source code. It's a pretty free-form document
+containing a loose collection of articles describing various aspects
+of xine's internals.
+</para>
+
+<para>
+This document has no intention to and therefore will never be complete or
+current in any way.
+</para>
+</sect1>
+
+<sect1>
+<title>New versions of this document</title>
+<para>
+This document is being developed in the xine-lib cvs repository within
+the directory <filename>doc/hackersguide/</filename>. If you are
+unsure what to do with the stuff in that directory, please read the
+<filename>README</filename> file located there.
+</para>
+<para>
+New versions of this document can also be obtained from the xine web
+site on sourceforge:
+
+<ulink url="http://xine.sf.net/">http://xine.sf.net/</ulink>.
+</para>
+</sect1>
+
+<sect1>
+<title>Feedback</title>
+<para>
+All comments, error reports, additional information and criticism of
+all sorts should be directed to the xine developer mailing list
+<email>xine-devel@lists.sourceforge.net</email>.
+</para>
+</sect1>
\ No newline at end of file