X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=docs%2FREADME;h=1ca9044550e7b9f2e3554f46becdf85040decdf0;hb=f45b4acc547ca85d9af9efa37d8caa68c20a42e6;hp=f109b8f220cce8e8bbe2d0216dd0ea6581fadfce;hpb=e04d8927f74bfce1ca8232a65b66c088e8a8406a;p=virtualjaguar diff --git a/docs/README b/docs/README index f109b8f..1ca9044 100644 --- a/docs/README +++ b/docs/README @@ -1,5 +1,5 @@ -------------------------------------------- -Virtual Jaguar v1.1.0 GCC/SDL release README +Virtual Jaguar v2.0.0 GCC/SDL release README -------------------------------------------- -------------- @@ -122,18 +122,25 @@ at the beginning of this file. After obtaining the Atari Jaguar boot ROM (and/or CD boot ROM) and several game ROMs you can now use Virtual Jaguar using the following command: -./vj [romfile] [-switches] +./virtualjaguar [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 -? (or ./vj -help) you get an overview of the options you can use. WIN32 -users should look into the stdout.txt in the directory they ran Virtual Jaguar -for that information. +./virtualjaguar -? (or ./virtualjaguar -help) you get an overview of the +options you can use. WIN32 users should look into the stdout.txt in the +directory they ran Virtual Jaguar for that information. Also, WIN32 users +should be aware that if their ROM filenames contain any spaces, you will have +to enclose the ROMFILE in double quotes for Virtual Jaguar to function +properly. + +Note that running Virtual Jaguar this way will cause the emulator to exit +completely upon pressing the ESC key. If this is not what you want, then omit +the ROMFILE and it will bring up a nice GUI instead. If you prefer a nice GUI instead of typing in command lines, you can either -type ./vj or double click on the Virtual Jaguar executable. If you have a -directory full of ROM files, you can tell Virtual Jaguar where they are by -editing the appropriate line in the vj.cfg file (it assumes a ROMs directory +type ./virtualjaguar or double click on the Virtual Jaguar executable. If you +have a directory full of ROM files, you can tell Virtual Jaguar where they are +by editing the appropriate line in the vj.cfg file (it assumes a ROMs directory under the directory where VJ lives) so that they show up when you pick the "Load" option from the "File" menu. @@ -192,3 +199,11 @@ David Raingeard of Potato Emulation who originally developed this emulator and released the sources to the public. We couldn't have done it without you! SDLEMU + + +*** Stuff to add in: + + o Documentation needs a rewrite, more or less, as the GUI is now front and + center. Need to update the docs to reflect this change. + o Document the new "solid" zip file archive mechanism which allows putting + artwork into a "ROM".