From 2b22bd24cd0299282dd62545a6815a689a54e74a Mon Sep 17 00:00:00 2001
From: Simon Howard
Date: Wed, 16 Apr 2008 20:30:04 +0000
Subject: Update some of the documentation.

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1115
---
 BUGS   | 17 ++++++++++++-----
 README | 21 +++++++++++++--------
 2 files changed, 25 insertions(+), 13 deletions(-)

diff --git a/BUGS b/BUGS
index 305dae3a..5dd8a531 100644
--- a/BUGS
+++ b/BUGS
@@ -8,11 +8,18 @@
 
 * Music plays back differently.
 
-  The DOS music code was not in the Doom source release as Doom used
-  a proprietary sound library.  The mus <-> mid conversion mostly 
-  works well but some patches are different.  By closer examination 
-  of which MIDI instruments are used by doom.exe, it may be possible
-  to get a closer conversion.
+  Vanilla Doom was typically played with a SoundBlaster (or compatible)
+  card.  It programmed the registers for the OPL music chip directly
+  in order to emulate the various General MIDI instruments.  However,
+  Chocolate Doom uses the OS's native MIDI playback interfaces to play
+  MIDI sound.  As the OPL is programmed differently, the music sounds
+  different to the original, even when using an original SoundBlaster
+  card.
+
+  This can be worked around in the future: OPL emulation code exists that
+  simulates an OPL chip in software.  Furthermore, depending on the OS,
+  it may be possible to program the OPL directly in order to get the 
+  same sound.
 
 * A small number of Doom bugs are almost impossible to emulate.
 
diff --git a/README b/README
index e1cce3d3..c0cf24df 100644
--- a/README
+++ b/README
@@ -56,18 +56,23 @@ Here are some examples:
  * More information, including information about how to play various classic
    TCs, is available on the Chocolate Doom website: 
 
-   http://www.chocolate-doom.org/
+     http://www.chocolate-doom.org/
 
    You are encouraged to sign up and contribute any useful information you may
    have regarding the port!
 
- * Chocolate Doom is not perfect.  See the BUGS file for a list of 
-   known issues,
+ * Chocolate Doom is not perfect.  See the BUGS file for a list of known
+   issues. New bug reports can be submitted to the Chocolate Doom bug
+   tracker on Sourceforge.  See:
 
- * Chocolate Doom is under the GNU GPL.  See the COPYING file for more 
-   information.
+     http://sourceforge.net/projects/chocolate-doom
 
- * Chocolate Doom is currently a beta version.  Not all planned features 
-   have been implemented yet; see TODO.  Please send feedback and bug 
-   reports to fraggle@gmail.com.  Thanks!
+ * Source code patches are welcome, but please follow the style guidelines -
+   see the file named HACKING included with the source distribution.
+
+ * Chocolate Doom is distributed under the GNU GPL.  See the COPYING file 
+   for more information.
+
+ * Please send any feedback, questions or suggestions to fraggle@gmail.com.  
+   Thanks!
 
-- 
cgit v1.2.3