[Scummvm-cvs-logs] CVS: docs/docbook manual.xml,1.15,1.16
Max Horn
fingolfin at users.sourceforge.net
Fri Dec 24 17:29:11 CET 2004
Update of /cvsroot/scummvm/docs/docbook
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv403
Modified Files:
manual.xml
Log Message:
some doc work
Index: manual.xml
===================================================================
RCS file: /cvsroot/scummvm/docs/docbook/manual.xml,v
retrieving revision 1.15
retrieving revision 1.16
diff -u -d -r1.15 -r1.16
--- manual.xml 24 Dec 2004 23:12:37 -0000 1.15
+++ manual.xml 25 Dec 2004 01:28:33 -0000 1.16
@@ -59,16 +59,20 @@
</section>
+<!--
<section>
<title>History</title>
<para>TODO: Insert some information about the history of ScummVM:
how it got started, how it evolved, etc.</para>
</section>
+-->
+<!--
<section>
<title>Getting further help</title>
<para>TODO</para>
</section>
+-->
<section>
<title>Reporting bugs</title>
@@ -113,14 +117,15 @@
<para>
The easiest way to contact the ScummVM team is by submitting bug reports or
commenting in our forums. You can also join and e-mail the scummvm-devel
-mailing list, or chat with us on irc (#scummvm on irc.freenode.net)
-Please do not ask us to support an unsupported game -- read our homepages
-FAQ first.
+mailing list (see <ulink url="http://lists.sourceforge.net/lists/listinfo/scummvm-devel"/>).
+Or chat with us on IRC: channel #scummvm on irc.freenode.net.
</para>
<para>
- TODO: Be a bit more verbose here: explain how to find/use the scummvm-devel list;
- and directly point at the FAQ entry in question (or maybe insert the response in
- here, or add the FAQ to the manual).
+Please do not ask us to support an unsupported game.
+We do <emphasis>not</emphasis> generally add support for non-SCUMM games!
+Reverse engineering a completely new game without source is a long process, and our
+developers are all very busy as it is... so unless you work for a company interested
+in providing us with source code for one of your classic titles, please do not ask.
</para>
</section>
</chapter>
@@ -130,15 +135,94 @@
<title>Getting started</title>
<section>
+ <title>Requirements</title>
+ <para>
+ TODO: List Requirements
+ (in terms of required/optional libraries, CPU power, memory, ...
+ In particular it would be nice if we could e.g. say what PalmOS devices support ScummVM;
+ not necessarily a list of all supported Palm models, but more a list of what OS you need
+ how much memory, colors, etc.)</para>
+
+ <para>ScummVM is known to run on the following systems:
+ </para>
+ <itemizedlist>
+ <listitem><para>Unix-like (Linux, *BSD, Solaris, etc.)</para></listitem>
+ <listitem><para>Windows</para></listitem>
+ <listitem><para>Mac OS X</para></listitem>
+ <listitem><para>Windows Mobile (WinCE / PocketPC / Smartphone)</para></listitem>
+ <listitem><para>PalmOS</para></listitem>
+ <listitem><para>Dreamcast</para></listitem>
+ </itemizedlist>
+ <para>
+ Besides these, there have been many more inofficial ports in the past.
+ Since they were not done by us, we can not say anything about their reliability,
+ legality, or availability, nor can we provide support for them. Use them at your own risk!
+ </para>
+ <para>
+ Among those systems are:
+ </para>
+ <itemizedlist>
+ <listitem><para>MorphOS</para></listitem>
+ <listitem><para>GP32</para></listitem>
+ <listitem><para>Symbian based smartphones</para></listitem>
+ <listitem><para>XBox</para></listitem>
+ <listitem><para>PlayStation 2</para></listitem>
+ <listitem><para>RISC OS</para></listitem>
+ </itemizedlist>
+
+ <para>
+ If you plan to compile ScummVM yourself, you will need certain additional libraries.
+ More on that in the section <xref linkend="sec.compiling"/> (<xref linkend="sec.compiling" endterm="sec.title.compiling"/>).
+ </para>
+
+ </section>
+
+ <section>
<title>How to get ScummVM</title>
+ <para>
+ Basically you have two choices on how to get ScummVM: either you download
+ one of the binaries we built for you (probably the most convenient way);
+ or you can compiler it yourself from source. We strongly recommend to
+ beginners to use our prebuilt binaries.
+ </para>
<section>
<title>Binaries</title>
- <para>TODO: list supported platforms; where to get binaries; list requirments
- (in terms of required/optional libraries, CPU power, memory, ...</para>
+ <para>
+ You can download ScummVM from our downloads page: <ulink url="http://www.scummvm.org/downloads.php"/>.
+ Go there with your favorite web browser and download the binary for your platform. If none
+ is available, you may have to build ScummVM yourself, refer to the next section for
+ instructions on how to do that.
+ </para>
+ <para>
+ We always ship prebuilt binaries of ScummVM for the following platforms (note that
+ it can sometimes take a few days after a release for all binaries to be available):
+ </para>
+ <itemizedlist>
+ <listitem><para>Linux (Fedora Core)</para></listitem>
+ <listitem><para>Linux (Debian)</para></listitem>
+ <listitem><para>Windows</para></listitem>
+ <listitem><para>Mac OS X</para></listitem>
+ <listitem><para>Windows Mobile (WinCE / PocketPC / Smartphone)</para></listitem>
+ <listitem><para>PalmOS</para></listitem>
+ <listitem><para>Dreamcast</para></listitem>
+ </itemizedlist>
+
+ <para>
+ In addition to these, we try to provide more binaries, but which depends mostly on
+ how many volunteers we can find to help us out. In the past we have shipped binaries
+ for these systems:
+ </para>
+ <itemizedlist>
+ <listitem><para>Linux (Mandrake)</para></listitem>
+ <listitem><para>Linux (Slackware)</para></listitem>
+ <listitem><para>Solaris</para></listitem>
+ <listitem><para>BeOS</para></listitem>
+ <listitem><para>MorphOS</para></listitem>
+ </itemizedlist>
</section>
- <section>
- <title>Compiling from source</title>
+ <section id="sec.compiling">
+ <title id="sec.title.compiling">Compiling from source</title>
<para>TODO:
(with more detail than now); pointer to
the to-be-written "Developer's Guide to ScummVM"
@@ -172,7 +256,7 @@
</section>
<section>
- <title>WinCE / PocketPC</title>
+ <title>Windows Mobile (WinCE / PocketPC / Smartphone)</title>
<para>TODO</para>
</section>
More information about the Scummvm-git-logs
mailing list