Update documentation to refect recent changes.

svn-id: r3932

2 files changed, 80 insertions, 40 deletions

diff --git a/readme.txt b/readme.txt
index 455d78760e..57d1012020 100644
--- a/readme.txt
+++ b/readme.txt
@@ -1,10 +1,11 @@
 ScummVM README
-Last updated:    2002-04-05
-Release version: 0.2.0
+Last updated:    2002-04-14
+Release version: 0.2.0  [CVS build]
 ------------------------------------------------------------------------
 
-For more information, the latest release and progress reports, please visit
-the ScummVM home page at: http://scummvm.sourceforge.net/
+For more information, compatability lists, details on donating, the latest
+release, progress reports and more, please visit the ScummVM home page
+at: http://scummvm.sourceforge.net/
 
 About:
 ------
@@ -16,18 +17,27 @@ ALPHA software, as it's still under heavy development. Be aware that while
 many games will work with few major bugs, crashes can happen. Also note
 that saved games can, and probably will, be incompatible between releases.
 
+Also ScummVM is capable of playing several non-SCUMM games, at the moment
+this includes Simon The Sorcerer.
+
+If you enjoy ScummVM feel free to donates using the PayPal button on the
+ScummVM homepage.
+
+
 Supported Games:
 ----------------
 
 At the moment the following games have been reported to work, and should
 be playable to the end:
 
-        Loom (256 color CD version)
-	Monkey Island 1 (CD version)
-	Monkey Island 2
-	Indiana Jones And The Fate Of Atlantis
-	Day Of The Tentacle
-        Sam & Max
+        Loom (256 color CD version)            [Game: loomcd]
+        Monkey Island 1 (CD version)           [Game: monkey1]
+        Monkey Island 2                        [Game: monkey2]
+        Indiana Jones And The Fate Of Atlantis [Game: atlantis]
+        Day Of The Tentacle                    [Game: tentacle]
+        Sam & Max                              [Game: samnmax]
+        Simon The Sorcerer                     [Game: simon1dos or simon1win]
+
 
 The following games should load, but are not yet fully playable. If you want
 the latest updates on game compatability, visit our website and view the
@@ -48,11 +58,12 @@ The following games are SCUMM engine, but NOT supported by ScummVM (yet).
 
 Please be aware that the engine may contains bugs and non-implemented-
 features that sometimes make it impossible to finish the game. Save often,
-and please file a bug report (follow the link on the homepage) if you
-discover such a bug. Attach a saved game if possible.
+and please file a bug report (details on submitted bug reports are below)
+if you discover such a bug.
 
 Supported Platforms:
 -------------------
+
 ScummVM has been ported to run on many platforms and operating systems.
 Links to these ports can be found either on the ScummVM webpage or by a
 google search. Many thanks to the effort of porters. If you have a port of
@@ -70,15 +81,17 @@ ScummVM and wish to commit it into the main CVS, feel free to contact us!
 
 Known Bugs:
 -----------
+
 This release has the following known bugs. There is no need to report them,
-although patches to fix them are welcome.
+although patches to fix them are welcome. If you discover a bug that is not
+listed here, nor in the compatability table on the website, please see below.
 
         Sam and Max:
                 - Subgames are not fully functional.
                 - Game may freeze if you look at the Dragon Heart, or trip
                   an alarm, at Bumpusville
                 - Some overlap may occur in graphics, expecially the intro
-                - Music does not work with USE_ADLIB
+                - Music does not work in adlib mode, use midi
 
        Loom (256 Talkie):
                 - CD music and voices are not always syncronised
@@ -89,11 +102,14 @@ although patches to fix them are welcome.
                 - Copy data files from CD to harddisk. Windows (XP at least)
                   cannot correctly access data from a volume playing music.
 
+
 Reporting Bugs:
 ---------------
+
 To report a bug, please create a SourceForge account and follow the bugs
 link from our homepage. Please make sure the bug is reproducable, and 
-still exists in the latest daily build/current CVS version.
+still exists in the latest daily build/current CVS version. Also check the
+compatability listing for that game to ensure the issue is not already known.
 
 Please include the following information:
 		- Game version (PLEASE test the latest CVS/Daily build)
@@ -106,12 +122,12 @@ Please include the following information:
 Compiling:
 ----------
 
-You need SDL-1.2.2 (maybe older versions will work), and a supported
-compiler. Several compilers, including GCC, mingw and Microsoft Visual C++
-are supported. If you wish to use MP3-compressed CD tracks or .SOU files,
-you will need to install the MAD library and define COMPRESSED_SOUND_FILE.
-Tools for compressing .SOU files to .SO3 files can be found in the 'tools'
-CVS module, or in the 'scummvm-tools' package.
+You need SDL-1.2.2 (older versions may work, but are unsupported), and a
+supported compiler. Several compilers, including GCC, mingw and Microsoft
+Visual C++ are supported. If you wish to use MP3-compressed CD tracks or
+.SOU files, you will need to install the MAD library and define
+COMPRESSED_SOUND_FILE. Tools for compressing .SOU files to .SO3 files can be
+found in the 'tools' CVS module, or in the 'scummvm-tools' package.
 
 	GCC:
 	* Type make (or gmake if that's what GNU make is called on your
@@ -173,15 +189,16 @@ Command Line Options:
         -m<num>   - set the music volume, 0-100  default is '60'
         -t<num>   - set music tempo              default is '2031616'
         -e<num>   - select sound engine. see below.
-        -g<num>   - select graphics scaler. see below.
+        -g<mode>  - select graphics scaler. see below.
 	-f        - fullscreen mode
         -n        - disable subtitles
-        -r        - enable roland conversion. Use this option if music doesn't sound correct.
+        -r        - enable roland conversion. try if music sounds incorrect.
+
 
 In game Hot Keys:
 -----------------
-
 	Ctrl 0-9 and Shift 0-9 to load and save states.
+        Ctrl-Alt 0-4 cycles between filter modes in the order listed below
 	Ctrl-z quits
 	Ctrl-f runs in fast mode.
 	Ctrl-d starts the debugger.
@@ -196,21 +213,25 @@ Graphics filters:
 ScummVM offers several antialiasing filters to attempt to improve visual
 quality. These are the same filters used in many other emulators, such as
 MAME. They are:
-        -g0 - No filtering. Fastest, obviously.
-        -g1 - 2xSal
-        -g2 - SuperSal. Less blurrier than 2x, but slightly slower
-        -g3 - SuperEagle.
+        -gnormal     - No filtering, original 320x200 resolution. Fastest.
+        -g2x         - No filtering, double screen/window size to 640x480
+        -g3x         - No filtering, triple screen/window size to 800x600
+        -g2xsai      - 2xsai filtering, double screen/window size to 640x480
+        -gsuper2xsai - Enhanced 2xsai filtering. 640x480 screen/window size
+        -gsupereagle - Less blurry than 2xsai, but slower. Also 640x480
 
-Note that at the moment filters are very slow, and slightly buggy. Use at 
-your own risk! .... but feel free to submit a bugfix or optimisation patch :)
+Note that filters are very slow when ScummVM is compiled in a debug
+configuration without optimisations. And there is always a speed impact when
+using any form of antialiasing/linear filtering.
 
 
 Music and Sound: 
 ----------------
 By default, on most operating systems, ScummVM will automatically use ADLIB
 emulation. However, some games do not include adlib music - such as Sam and
-Max. To hear music in such games, you will need to remove the 'USE_ADLIB'
-define and recompile using Midi support.. (TODO: Make ADLIB and MIDI dynamic!)
+Max. ScummVM will automatically switch to MIDI for these games - however note
+that MIDI may not be available on all operating systems or may need manual
+configuration.
 
 If you ARE using MIDI, you have several different choices of output, 
 depending on your operating system and configuration.
@@ -222,11 +243,15 @@ depending on your operating system and configuration.
 
 Playing sound with Adlib emulation:
 -----------------------------------
-If you compile ScummVM with the USE_ADLIB flag, an Adlib card will be
-emulated and ScummVM will output the music as sampled waves. This offers
-far superior preformance to Timidity, however does not work with some games
-such as Sam and Max.
+By default an Adlib card will be emulated and ScummVM will output the music
+as sampled waves. This offers far superior preformance to Timidity, however
+does not work with some games such as Sam and Max.
 
+Playing sound with MIDI:
+------------------------
+On Windows, MorphOS and Macintosh, MIDI will automatically be configured.
+However under UNIX, you may need to configure MIDI manually. Please see the
+below sections for information on using the various MIDI methods.
 
 Playing sound with Sequencer:
 -----------------------------
@@ -241,10 +266,10 @@ Playing music with Timidity:
 ----------------------------
 Start Timidity with the following command line :
 	$ timidity -irv 7777
-Then start ScummVM with the parameter '-e2'. However, Timidity is not designed
-to cope with the rapid changes most iMUSE equipped games use - so Adlib emulation
-or sequencer support are the recommended methods for non-windows/non-macintosh 
-users.
+Then start ScummVM with the parameter '-e2'. However, Timidity is not
+designed to cope with the rapid changes most iMUSE equipped games use - so
+its use over Adlib emulation or sequencer support is not recommended.
+
 
 
 Savegames:
diff --git a/whatsnew.txt b/whatsnew.txt
index f7be17e45f..97c40486fe 100644
--- a/whatsnew.txt
+++ b/whatsnew.txt
@@ -1,3 +1,18 @@
+For a more comprehensive changelog, see:
+        http://scummvm.sourceforge.net/daily/ChangeLog
+
+0.2.0 (2002-04-14)
+- countless fixes for games
+- sam and max is completable
+- loom talkie is completable (although some bugs remain)
+- our first non-SCUMM game, Simon the Sorcerer, is supported.
+- 2xsai, super2xsai and supereagle graphics filtering support
+- more ports and platforms than ever before
+- new commandline options and ingame options/volume settings.
+- large code rewrite
+- experimental support for indy3 (256), zak256, the dig and full throttle;
+  not complete or totally playable yet, so don't report bugs.
+
 0.1.0 (2002-01-13)
 - loads of changes