Move most files under doc/.

[vga2scart.git] / doc / index.mdwn

diff --git a/doc/index.mdwn b/doc/index.mdwn
new file mode 100644 (file)
index 0000000..580fd7a
--- /dev/null
+++ b/doc/index.mdwn
@@ -0,0 +1,85 @@
+The provided patches enable you to directly drive [[!wikipedia RGB]]/[[!wikipedia PAL]] [[!wikipedia SCART]] devices like a TV set.
+
+Using those patches you can build a cheap but high quality video replay device with that.
+
+To get going you need to apply the patches and probably you need also a [[VGA2SVGA cable|cable]].
+
+Patchset
+========
+
+If you ever wished to synchronize your VGA timing to an external signal source
+like a DVB stream, this patch collection could be interesting for you.
+
+It implements a kind of soft-PLL locking on the external signal. The VCO is
+represented by dynamically adjusted VGA frame rate aka video timing.
+
+Required Patches
+----------------
+
+There are the following cases to be distinguished. Depending on this the following software needs to be patched.
+
+1. [[!wikipedia ATI Radeon]] without [[!wikipedia Frame Rate Control]]
+  - [xserver-xorg-video-radeon][xorg-radeon] (newer versions may not need it)
+2. Intel i9xx without [[!wikipedia Frame Rate Control]]
+  - [xserver-xorg-video-intel][xorg-intel]
+3. [[!wikipedia ATI Radeon]] with [[!wikipedia Frame Rate Control]]
+  - [xserver-xorg-video-radeon][xorg-radeon]
+  - xineliboutput (newer versions already adopted the patch)
+  - xine-lib
+  - radeon-drm kernel module
+4. Intel i9xx with [[!wikipedia Frame Rate Control]]
+  - [xserver-xorg-video-intel][xorg-intel]
+  - xineliboutput (newer versions already adopted the patch)
+  - xine-lib
+
+There is [[an overview|hardwarelist]] of tested models and [[a status page|upstreamstatus]] about the inclusion of these packages upstream.
+
+Installation
+------------
+There are several ways to install the patches.
+
+1. Use easyVDR. The patches are already applied to the packages in easyVDR, a complete [VDR][vdr] distribution based on [Debian Etch][DebianEtch].
+2. Use a [shell script][EasyVDR-InstallScript].
+3. Install everything manually as documented in [[INSTALL]] or in German in [CheapBudget][EasyVDR-CheapBudget].
+
+The VGA2SCART Community
+=======================
+
+Mailing list
+------------
+There is no mailing list yet.
+
+Internet Relay Chat
+-------------------
+No channel has been setup yet.
+
+Development
+-----------
+The distributed version control system Git is used. Having installed Git you can clone each project which needs to be patched using git clone.
+
+### Individual developers repositories ###
+If you are interested in the latest developments please take a look at the repositories of the individual developers.
+
+### TODO ###
+There is a [[TODO]] list.
+
+Contact
+-------
+Please contact the developers over the mailing list.
+
+Further information
+===================
+
+To get more information about this topic at …
+
+
+[xorg-radeon]: http://xorg.freedesktop.org/wiki/radeon
+[xorg-intel]: http://xorg.freedesktop.org/wiki/intel
+[vdr]: http://www.cadsoft.de/vdr/ "Video Disk Recorder"
+[EasyVDR-InstallScript]: http://www.easy-vdr.de/forum/index.php?topic=6072.msg51320#msg51320
+[EasyVDR-CheapBudget]: http://vdr-wiki.de/wiki/index.php/CheapBudget
+[DebianEtch]: http://www.debian.org/releases/etch/ "Debian Etch"
+
+----
+
+This wiki is powered by [ikiwiki](http://ikiwiki.info/).