Win32 README as a docbook file

Original commit message from CVS:
Win32 README as a docbook file

diff --git a/ChangeLog b/ChangeLog
index 9cf1e46..5f9c0e9 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2004-06-12  Steve Lhomme  <steve.lhomme@free.fr>
 
+       * docs/manual/win32.xml:
+          attempt to transform the Win32 README into an XML doc
+
+2004-06-12  Steve Lhomme  <steve.lhomme@free.fr>
+
        * gst/gst.c:
        * gst/gstbin.*:
        * gst/gstelement.*:

diff --git a/common b/common
index 2188863..1af22af 160000 (submodule)
--- a/common
+++ b/common
@@ -1 +1 @@
-Subproject commit 21888634686506a6938e435f9c4fd5a9f20ccc3e
+Subproject commit 1af22afdec71295108f882c828e08f10d8a3e94b

diff --git a/docs/manual/appendix-win32.xml b/docs/manual/appendix-win32.xml
new file mode 100644 (file)
index 0000000..e699afe
--- /dev/null
+++ b/docs/manual/appendix-win32.xml
@@ -0,0 +1,58 @@
+<chapter id="chapter-win32">
+  <title>Building <application>GStreamer</application> under Win32</title>
+<para>There are different makefiles that can be used to build GStreamer with the usual Microsoft 
+compiling tools.</para>
+
+<para>The Makefile is meant to be used with the GNU make program and the free 
+version of the Microsoft compiler (<ulink url="http://msdn.microsoft.com/visualc/vctoolkit2003/">http://msdn.microsoft.com/visualc/vctoolkit2003/</ulink>). You also 
+have to modify your system environment variables to use it from the command-line. You will also 
+need a working Platform SDK for Windows that is available for free from Microsoft.</para>
+
+<para>The projects/makefiles will generate automatically some source files needed to compile 
+GStreamer. That requires that you have installed on your system some GNU tools and that they are 
+available in your system PATH.</para>
+
+<para>The GStreamer project depends on other libraries, namely :</para>
+<itemizedlist>
+<listitem><para>GLib</para></listitem>
+<listitem><para>libpopt</para></listitem>
+<listitem><para>libxml</para></listitem>
+<listitem><para>libintl</para></listitem>
+<listitem><para>libiconv</para></listitem>
+</itemizedlist>
+
+<para>The sources should be organised in folders as follow :</para>
+<itemizedlist>
+<listitem><para>$(PROJECT_DIR)\glib</para></listitem>
+<listitem><para>$(PROJECT_DIR)\gstreamer (this package)</para></listitem>
+<listitem><para>$(PROJECT_DIR)\libiconv</para></listitem>
+<listitem><para>$(PROJECT_DIR)\libintl</para></listitem>
+<listitem><para>$(PROJECT_DIR)\libxml2</para></listitem>
+<listitem><para>$(PROJECT_DIR)\popt</para></listitem>
+</itemizedlist>
+
+<note>
+<title>Notes</title>
+
+<para>you can find Win32 versions of these libraries on <ulink url="http://gettext.sourceforge.net/">http://gettext.sourceforge.net/</ulink> and
+<ulink url="http://gnuwin32.sourceforge.net/">http://gnuwin32.sourceforge.net/</ulink> (you will need the Binaries and Developer files for each package).</para>
+
+<para>GLib can be found on <ulink url="ftp://ftp.gtk.org/pub/gtk/v2.4/" type="ftp">ftp://ftp.gtk.org/pub/gtk/v2.4/</ulink> and should be compiled from the 
+sources</para>
+
+<para>NOTE : GNU tools needed that you can find on <ulink url="http://gnuwin32.sourceforge.net/">http://gnuwin32.sourceforge.net/</ulink></para>
+<itemizedlist>
+<listitem><para>GNU flex      (tested with 2.5.4)</para></listitem>
+<listitem><para>GNU bison     (tested with 1.35)</para></listitem>
+</itemizedlist>
+
+<para>and <ulink url="http://www.mingw.org/">http://www.mingw.org/</ulink></para>
+<itemizedlist>
+<listitem><para>GNU make      (tested with 3.80)</para></listitem>
+</itemizedlist>
+
+<para>the generated files from the -auto makefiles will be available soon separately on the net 
+for convenience (people who don't want to install GNU tools).</para>
+</note>
+
+</chapter>

diff --git a/docs/manual/win32.xml b/docs/manual/win32.xml
new file mode 100644 (file)
index 0000000..e699afe
--- /dev/null
+++ b/docs/manual/win32.xml
@@ -0,0 +1,58 @@
+<chapter id="chapter-win32">
+  <title>Building <application>GStreamer</application> under Win32</title>
+<para>There are different makefiles that can be used to build GStreamer with the usual Microsoft 
+compiling tools.</para>
+
+<para>The Makefile is meant to be used with the GNU make program and the free 
+version of the Microsoft compiler (<ulink url="http://msdn.microsoft.com/visualc/vctoolkit2003/">http://msdn.microsoft.com/visualc/vctoolkit2003/</ulink>). You also 
+have to modify your system environment variables to use it from the command-line. You will also 
+need a working Platform SDK for Windows that is available for free from Microsoft.</para>
+
+<para>The projects/makefiles will generate automatically some source files needed to compile 
+GStreamer. That requires that you have installed on your system some GNU tools and that they are 
+available in your system PATH.</para>
+
+<para>The GStreamer project depends on other libraries, namely :</para>
+<itemizedlist>
+<listitem><para>GLib</para></listitem>
+<listitem><para>libpopt</para></listitem>
+<listitem><para>libxml</para></listitem>
+<listitem><para>libintl</para></listitem>
+<listitem><para>libiconv</para></listitem>
+</itemizedlist>
+
+<para>The sources should be organised in folders as follow :</para>
+<itemizedlist>
+<listitem><para>$(PROJECT_DIR)\glib</para></listitem>
+<listitem><para>$(PROJECT_DIR)\gstreamer (this package)</para></listitem>
+<listitem><para>$(PROJECT_DIR)\libiconv</para></listitem>
+<listitem><para>$(PROJECT_DIR)\libintl</para></listitem>
+<listitem><para>$(PROJECT_DIR)\libxml2</para></listitem>
+<listitem><para>$(PROJECT_DIR)\popt</para></listitem>
+</itemizedlist>
+
+<note>
+<title>Notes</title>
+
+<para>you can find Win32 versions of these libraries on <ulink url="http://gettext.sourceforge.net/">http://gettext.sourceforge.net/</ulink> and
+<ulink url="http://gnuwin32.sourceforge.net/">http://gnuwin32.sourceforge.net/</ulink> (you will need the Binaries and Developer files for each package).</para>
+
+<para>GLib can be found on <ulink url="ftp://ftp.gtk.org/pub/gtk/v2.4/" type="ftp">ftp://ftp.gtk.org/pub/gtk/v2.4/</ulink> and should be compiled from the 
+sources</para>
+
+<para>NOTE : GNU tools needed that you can find on <ulink url="http://gnuwin32.sourceforge.net/">http://gnuwin32.sourceforge.net/</ulink></para>
+<itemizedlist>
+<listitem><para>GNU flex      (tested with 2.5.4)</para></listitem>
+<listitem><para>GNU bison     (tested with 1.35)</para></listitem>
+</itemizedlist>
+
+<para>and <ulink url="http://www.mingw.org/">http://www.mingw.org/</ulink></para>
+<itemizedlist>
+<listitem><para>GNU make      (tested with 3.80)</para></listitem>
+</itemizedlist>
+
+<para>the generated files from the -auto makefiles will be available soon separately on the net 
+for convenience (people who don't want to install GNU tools).</para>
+</note>
+
+</chapter>