[gephex-devel] gephex--main--0.4--patch-1851

[gephex at sonnenland.kexbox.org]

Archive: gephex at gephex.org--2004
New revision: gephex--main--0.4--patch-1851

--
Revision: gephex--main--0.4--patch-1851
Archive: gephex at gephex.org--2004
Creator: The Gephex Source Archive <gephex at gephex.org>
Date: Fri Mar  4 20:16:01 CET 2005
Standard-date: 2005-03-04 19:16:01 GMT
New-files: .arch-ids/README.macosx.id README.macosx
Modified-files: doc/documentation.xml
New-patches: georg at gephex.org--2005-ibook/gephex--macport--0.4--patch-18
    georg at gephex.org--2005-ibook/gephex--macport--0.4--patch-19
    gephex at gephex.org--2004/gephex--main--0.4--patch-1851
Summary: [MERGE-REQUEST] Updated documentation (build instructions for mac os x), added README.macosx
Keywords: 

Patches applied:

 * georg at gephex.org--2005-ibook/gephex--macport--0.4--patch-18
   Added readme file for mac os x

 * georg at gephex.org--2005-ibook/gephex--macport--0.4--patch-19
   Updated documentation: now mac os x is supported os, added section about building on mac os x

* added files

    .arch-ids/README.macosx.id
    README.macosx
    {arch}/gephex/gephex--macport/gephex--macport--0.4/georg at gephex.org--2005-ibook/patch-log/patch-18
    {arch}/gephex/gephex--macport/gephex--macport--0.4/georg at gephex.org--2005-ibook/patch-log/patch-19
    {arch}/gephex/gephex--main/gephex--main--0.4/gephex at gephex.org--2004/patch-log/patch-1851

* modified files

--- orig/doc/documentation.xml
+++ mod/doc/documentation.xml
@@ -70,7 +70,7 @@
 You can use, distribute and modify GePhex under the terms of the GPL.
 </para></listitem>
 
-<listitem><para>GePhex is a multi platform project. Supported operating systems are Win32 and Linux. Ports to the BSD operating systems and Mac OSX are planned.</para></listitem>
+<listitem><para>GePhex is a multi platform project. Supported operating systems are Win32, Linux, and Mac OS X. There is also a port to FreeBSD.</para></listitem>
 </itemizedlist>
 </para>
 <para>
@@ -238,7 +238,7 @@
 <para>Since GePhex is free software you can get the source code and compile it on you own.
 Or if you have one of our core platforms you can download the precompiled binaries from our <ulink url="http://www.gephex.org"><citetitle>website</citetitle></ulink>.</para>
 
-<sect1><title>Building from the Sources</title>
+<sect1 id="sec.building"><title>Building from the Sources</title>
 
   <para>
     It is not very difficult to compile your own version of GePhex.
@@ -529,6 +529,84 @@
 </sect3>
 </sect2>
 
+<sect2><title>Building on Mac OS X</title>
+
+<para>
+
+Building on Mac OS X is very similar to building on other UNIX systems.
+
+<para>
+Note that the tools described here are only one choice of several
+alternatives. If you find a better way to build gephex on Mac OS X
+ <ulink url="http://lists.gephex.org/mailman/listinfo">
+   <citetitle>let us know</citetitle></ulink>.
+</para>
+
+Here comes a list with tools that can be used to build gephex.
+
+<itemizedlist>
+<listitem><para> 
+  <ulink url="http://fink.sourceforge.net/"><citetitle>fink</citetitle></ulink>
+</para></listitem>
+
+ <listitem><para>
+   the developer tools from apple (I got them from my installation cd,
+   but i installed an update to gcc from 
+   <ulink url="https://connect.apple.com/"><citetitle>here</citetitle></ulink>)
+ </para></listitem>
+
+ <listitem><para>
+   x11 server + sdk (for example 
+   <ulink url="http://www.apple.com/macosx/features/x11/">
+     <citetitle>this one</citetitle></ulink>
+   comes as an extra package with the developer tools)
+  </para></listitem>
+
+ <listitem><para>
+   qt (I used finks qt)
+ </para></listitem>
+
+ <listitem><para>
+   sdl and sdl_image (for loading images other than bmp files, again
+   I used finks versions)
+ </para></listitem>
+
+ </itemizedlist>
+
+ <para>
+ After that everything should work as described
+ in <xref linkend="sec.building"/>.
+ </para>
+
+ <para>
+ If you manage to compile and link gephex against the native
+ qt version for Mac OS X please 
+ <ulink url="http://lists.gephex.org/mailman/listinfo">
+   <citetitle>let us know</citetitle></ulink>!
+ </para>
+
+We are looking for people to improve gephex on mac os x.
+Important areas that need work: 
+
+ <itemizedlist>
+   <listitem><para>
+   audio support (audio input and audio output module)
+   </para></listitem>
+
+   <listitem><para>
+   better output driver (current x11 output is slow, sdl seems broken)
+   </para></listitem>
+
+   <listitem><para>
+   altivec optimisations of some basic modules (xfader, ...)
+   </para></listitem>
+  </itemizedlist>
+
+ If you are interested  <ulink url="http://lists.gephex.org/mailman/listinfo">
+   <citetitle>let us know</citetitle></ulink>!
+
+</para>
+</sect2>
 <sect2><title>Building on Windows</title>
 
 <sect3><title>What you need</title>  
@@ -1349,7 +1427,7 @@
 <para>
 To add a new effect module, it is best to use pluc, our plugin code generator.
 It can produce much of the boilerplate code from a simple module
-specification (see ...).
+specification (see <xref linkend="sec.pluc"/>).
 </para>
 
 <para>
@@ -1414,7 +1492,7 @@
 
     </sect2>
 
-    <sect2>
+    <sect2 id="sec.pluc">
       <title>Pluc the skeleton generator</title>
 
 <para>