From: Shamus Hammons <jlhamm@acm.org>
Date: Thu, 27 Sep 2012 23:31:10 +0000 (-0500)
Subject: Updated documentation, mainly for the benefit of win32 users.
X-Git-Tag: 2.1.0~14
X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?p=virtualjaguar;a=commitdiff_plain;h=8443b45aa7ff1521dddf7a7f189eee29956b6cca

Updated documentation, mainly for the benefit of win32 users.
---

diff --git a/docs/README b/docs/README
index 5d27f3e..9d1a1b2 100644
--- a/docs/README
+++ b/docs/README
@@ -104,10 +104,44 @@ http://www.libsdl.org. Thanks Sam--you rock! :)
 - Using Virtual Jaguar GCC/Qt -
 -------------------------------
 
-Simply double click on the Virtual Jaguar icon or type ./virtualjaguar from
+Simply double click on the Virtual Jaguar icon or type ./virtualjaguar -h from
 the command line. See the built in help (under Help|Contents) for more
 information on how to use it. :-)
 
+People on Windows platforms are unable to read the from the command line at
+the moment. So here's what it says:
+
+"Virtual Jaguar GIT 20120914 (2.1.0 Prerelease)
+Based upon Virtual Jaguar core v1.0.0 by David Raingeard.
+Written by James Hammons (Linux/WIN32), Niels Wagenaar (Linux/WIN32),
+Carwin Jones (BeOS), and Adam Green (MacOS)
+Contact: http://sdlemu.ngemu.com/ | sdlemu@ngemu.com
+
+Usage:
+   virtualjaguar [<filename>] [switches]
+
+   Option            Description
+   ----------------  -----------------------------------
+   <filename>        Name of file to autoload
+   --alpine      -a  Put Virtual Jaguar into Alpine mode
+   --pal         -p  PAL mode
+   --ntsc        -n  NTSC mode
+   --bios        -b  Boot using Jagaur BIOS
+   --no-bios         Do not use Jaguar BIOS
+   --gpu         -g  Enable GPU
+   --no-gpu          Disable GPU
+   --dsp         -d  Enable DSP
+   --no-dsp          Disable DSP
+   --fullscreen  -f  Start in full screen mode
+   --blur        -B  Enable GL bilinear filter
+   --no-blur         Disable GL bilinear filtering
+   --log         -l  Create and use log file
+   --no-log          Do not use log file
+   --help        -h  Show this message
+
+Invoking Virtual Jagaur with no filename will cause it to boot up
+with the VJ GUI."
+
 -----------
 - Finally -
 -----------
diff --git a/docs/TODO b/docs/TODO
index 178aa37..853bb0c 100644
--- a/docs/TODO
+++ b/docs/TODO
@@ -16,16 +16,18 @@ Stuff to add/fix for the next release of Virtual Jaguar
 - Blitter needs fixing. [Shamus]
 - In emulator screenshots. [Shamus]
 - Audio/video dumping. [Shamus]
-- Full screen option. [Shamus]
 - Controller handling. [Shamus]
 - Need to emulate bus contention. [Shamus]
 - Need to fix timing in the OP. As it is now, it gives a false impression of
   how much it's capable of. [Shamus]
+- Fix coming out of fullscreen on Win32. As of now, it doesn't restore the
+  window position correctly [CJ]
 
 
 Stuff that was added/fixed
 --------------------------
 
+- Full screen option. [Shamus] [DONE--Shamus]
 - Command line switches for frontends. [Shamus] [DONE-Shamus]
 - Fix DSP code so that it doesn't hang in a spinlock waiting for the sound
   buffer to empty. Probably a CS lock contention issue. [Shamus] [DONE-Shamus]
diff --git a/docs/WHATSNEW b/docs/WHATSNEW
index a336c6d..7c47b76 100644
--- a/docs/WHATSNEW
+++ b/docs/WHATSNEW
@@ -1,6 +1,8 @@
 Virtual Jaguar v2.1.0 GCC/Qt
 ----------------------------
 
+* Added fullscreen option. [Shamus]
+* Added some more developer goodies to Alpine mode. [Shamus]
 * Re-added command line switches. [Shamus]
 * Moved JERRY into host audio IRQ. This should make sound much smoother, though
   it may run ahead of the rest of the emulator. [Shamus]