diff options
author | Michael Roitzsch <mroi@users.sourceforge.net> | 2003-10-12 19:06:43 +0000 |
---|---|---|
committer | Michael Roitzsch <mroi@users.sourceforge.net> | 2003-10-12 19:06:43 +0000 |
commit | 60239a297dd0e7a6454dbd15de9d0186dea93c14 (patch) | |
tree | 631575dda5455ec4b4e0e7695dad2b41a0bbfd75 /doc/hackersguide/intro.sgml | |
parent | 102661e8630883383e0a0c1d2d31765cce1ebc84 (diff) | |
download | xine-lib-60239a297dd0e7a6454dbd15de9d0186dea93c14.tar.gz xine-lib-60239a297dd0e7a6454dbd15de9d0186dea93c14.tar.bz2 |
updated hackersguide:
* added some small pieces
* incorporated some former READMEs and Mike's fabulous demuxer and decoder doc
* splitted into multiple files
* made new drawings (hopefully I am not the only one to understand them)
* Makefile support for building a HTML version which is now
installed in the user's doc directory
CVS patchset: 5494
CVS date: 2003/10/12 19:06:43
Diffstat (limited to 'doc/hackersguide/intro.sgml')
-rw-r--r-- | doc/hackersguide/intro.sgml | 99 |
1 files changed, 49 insertions, 50 deletions
diff --git a/doc/hackersguide/intro.sgml b/doc/hackersguide/intro.sgml index b2bcfa909..c7dce6254 100644 --- a/doc/hackersguide/intro.sgml +++ b/doc/hackersguide/intro.sgml @@ -1,55 +1,54 @@ -<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>. Specifically -this document goes under the moniker of the 'xine Hackers' Guide'. -</para> -</sect1> +<chapter id="intro"> + <title>Introduction</title> -<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. It has been written by a number of people who work -on xine themselves and is intended to provide the important concepts and -methods used within xine. Readers should not consider this document to be -an exhausative description of the internals of xine. As with all projects -which provide access, the source-code should be considered the definative source -of information. -</para> + <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://xinehq.de/">http://xinehq.de/</ulink>. Specifically + this document goes under the moniker of the "xine Hackers' Guide". + </para> + </sect1> -<para> -This document has no intention to be, and therefore never will be, complete or -current in any way. Instead it should be considered a read-map pointing the -casual hacker to the correct location in the xine source. -</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. It has been written by a number of people who work + on xine themselves and is intended to provide the important concepts and + methods used within xine. Readers should not consider this document to be + an exhausative description of the internals of xine. As with all projects + which provide access, the source-code should be considered the definitive + source of information. + </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: + <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: + <ulink url="http://xinehq.de/">http://xinehq.de/</ulink>. + </para> + </sect1> -<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 + concerning this document should be directed to the xine documentations + mailing list <email>xine-docs@lists.sourceforge.net</email>. + Questions about xine hacking in general should be sent to the + developer mailing list <email>xine-devel@lists.sourceforge.net</email>. + </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> +</chapter> |