Updated documentation, mainly for the benefit of win32 users.

[virtualjaguar] / docs / README

diff --git a/docs/README b/docs/README
index 5d27f3e3380f311d44ea3e66ef1ca6d3fcd471d8..9d1a1b2aba19fe1a67e21a3988070d9c1e6c16f4 100644 (file)
--- 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 -
 -----------