Added some GL filter defaults

[virtualjaguar] / docs / README

diff --git a/docs/README b/docs/README
index 869e1becc8360212765b6d57465f8e1b44849cfa..d223e2dbb45fcc60a8e946a5d2ad603952a232ce 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -1,4 +1,4 @@
-Virtual Jaguar v1.0.5 GCC/SDL release README
+Virtual Jaguar v1.0.6 GCC/SDL release README

 --------------------------------------------
 
 - DISCLAIMER -
 --------------------------------------------
 
 - DISCLAIMER -


@@ -29,7 +29,7 @@ by the desired company in question.
 - What is Virtual Jaguar GCC/SDL?
 
 Virtual Jaguar is software dedicated to emulate the Atari Jaguar hardware
 - What is Virtual Jaguar GCC/SDL?
 
 Virtual Jaguar is software dedicated to emulate the Atari Jaguar hardware

-on you standard P.C. The software was originally developed by Potato Emulation
+on a standard P.C. The software was originally developed by Potato Emulation

 (http://potato.emu-france.com) by Cal2 and was released under the GPL license
 on 25 June 2003. 
 
 (http://potato.emu-france.com) by Cal2 and was released under the GPL license
 on 25 June 2003. 
 


@@ -50,31 +50,31 @@ More information about SDL can be found at http://www.libsdl.org.
 - Using Virtual Jaguar GCC/SDL
 
 After compiling the binary (see INSTALL) you can now run original Atari Jaguar
 - Using Virtual Jaguar GCC/SDL
 
 After compiling the binary (see INSTALL) you can now run original Atari Jaguar

-games. These games are distributed on cartridges and can there for not be used
-on a P.C. To use these games on Virtual Jaguar GCC/SDL you need to get ROM
-images. Besides that ROM images from Commercial games you must also obtain the
-Atari Jaguar (CD) boot ROM which you must copy to the BIOS directory. 
-For legal issues concerning ROM images please consult the DISCLAIMER at the
-beginning of this file.
-
-After obtaining the Atari Jaguar (CD) boot ROM and several ROM's you can now
+games. These games are distributed on cartridges and can there for cannot be
+used on a P.C. To use these games on Virtual Jaguar GCC/SDL you need to get ROM
+images. Besides the ROM images from commercial games you must also obtain the
+Atari Jaguar (CD) boot ROM which you must copy to the BIOS directory. For legal
+issues concerning ROM images please consult the DISCLAIMER at the beginning of
+this file.
+
+After obtaining the Atari Jaguar (CD) boot ROM and several ROMs you can now

 use Virtual Jaguar using the following command:
 
 ./vj [romfile] [-switches]
 
 The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
 either compressed or uncompressed). You can also use switches. By just typing
 use Virtual Jaguar using the following command:
 
 ./vj [romfile] [-switches]
 
 The context of ROMFILE is the filename of the an Atari Jaguar ROM dump (can be
 either compressed or uncompressed). You can also use switches. By just typing

-./vj -? you get an overview of the options you can use. WIN32 users should look
-into the stdout.txt for that information. If you have a directory full of ROM
-files, then you can type
+./vj -? (or ./vj -help) you get an overview of the options you can use. WIN32
+users should look into the stdout.txt for that information. If you have a
+directory full of ROM files, you can type

 
 ./vj [directory with ROM files] [-switches]
 
 and Virtual Jaguar will pull up a simple file selector to allow you to choose
 which ROM file you want to use.
 
 
 ./vj [directory with ROM files] [-switches]
 
 and Virtual Jaguar will pull up a simple file selector to allow you to choose
 which ROM file you want to use.
 

-This emulator also emulates the Atari Jaguar Analog gamepads. By using the
-following keyboard or joystick settings you can (possibly) play the game:
+This emulator also emulates the Atari Jaguar gamepads. By using the following
+keyboard or joystick settings you can (possibly) play a given game:

 
 Atari Button C       : Z or joystick button 3
 Atari Button B       : X or joystick button 2
 
 Atari Button C       : Z or joystick button 3
 Atari Button B       : X or joystick button 2


@@ -86,11 +86,12 @@ Atari UP             : UP    or joystick UP
 Atari DOWN           : DOWN  or joystick DOWN
 Atari LEFT           : LEFT  or joystick LEFT
 Atari RIGHT          : RIGHT or joystick RIGHT
 Atari DOWN           : DOWN  or joystick DOWN
 Atari LEFT           : LEFT  or joystick LEFT
 Atari RIGHT          : RIGHT or joystick RIGHT

-Atari *, # are not mapped yet!
+Atari #              : Keypad /
+Atari *              : Keypad *

 
 With ESC you can easily stop Virtual Jaguar GCC/SDL which will get you back
 
 With ESC you can easily stop Virtual Jaguar GCC/SDL which will get you back

-to you command prompt. If you want to change the key layout, simply hack the
-src/joystick.cpp and change the keys :)
+to you command prompt. If you want to change the key layout, simply edit the
+vj.cfg file and change the keys :)

 
 - Finally
 
 
 - Finally
 


@@ -102,8 +103,8 @@ website : http://sdlemu.ngemu.com.
 
 I hope you enjoy the emulator and will use it wisely! 
 
 
 I hope you enjoy the emulator and will use it wisely! 
 

-Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Also the author
-who originally developed this emulator is thanked for releasing the sources to
-the public.
+Special thanks go to guys over at ngemu.com and #ngemu (EFNET). Also Cal2 of
+Potato Emulation who originally developed this emulator is thanked for
+releasing the sources to the public.

 
 SDLEMU
 
 SDLEMU