Added Object Processor browser window for debug mode.

[virtualjaguar] / docs / README

diff --git a/docs/README b/docs/README
index 5e5d3b17ee7ce9ed9277192002a3b861a056d773..9d1a1b2aba19fe1a67e21a3988070d9c1e6c16f4 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -1,5 +1,5 @@
 -------------------------------------------
-Virtual Jaguar v2.0.2 GCC/Qt release README
+Virtual Jaguar v2.1.0 GCC/Qt release README
 -------------------------------------------
 
 --------------
@@ -15,21 +15,18 @@ software requirements.
 
 The use of this software is entirely at your own risk. While it won't rape
 your dog, it might do other nasty things. We can't be held responsible for
-damage done to you hardware and/or software. You may only use the ROM images if
-you own the cartridges itself. The use of Commercial ROMs without owning the
+damage done to your hardware and/or software. You may only use the ROM images
+if you own the cartridges itself. The use of commercial ROMs without owning the
 original cartridge is illegal in most countries and could result in fines
 and/or legal actions.
 
-This software is released under the GPL v3 or later. For more information I
-direct you to the GPLv3 file. You may hack/change the code anyway you like. You
-may not commercially sell this software. If you make changes, release the
-source code to the public and send the changes you made to the original
-authors.
-
 The products, trademarks and/or brands used in these documents and/or
 sourcecode are owned by their respective companies and/or successors in
 interest.
 
+This software is released under the GPL v3 or later. For more information, read
+the GPLv3 file.
+
 ----------------------------------------------------------------
 - IMPORTANT NOTE ABOUT JAGUAR FILE FORMATS--READ THIS OR ELSE! -
 ----------------------------------------------------------------
@@ -96,7 +93,7 @@ systems as well but we can not guarantee that.
 
 The port was done by the SDLEMU crew (http://sdlemu.ngemu.com) and especially
 by Niels Wagenaar and Carwin Jones. A major portion of the rewrite was done by
-James L. Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
+James Hammons. You may contact us by e-mail (sdlemu@ngemu.com) or leave a
 message on the SDLEMU Official Forum (see the website). Patches and bugfixes
 are particularly welcome! :)
 
@@ -107,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 -
 -----------