summaryrefslogtreecommitdiff
path: root/doc/hackersguide/intro.sgml
blob: b2bcfa90910b414e9111aaedf0d29d78dc963461 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
<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>

<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>

<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>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>