X-Git-Url: http://shamusworld.gotdns.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=docs%2FINSTALL;h=c81b0a5d3f2041e74e16cae1c26189c6a7ef8bda;hb=5b056aa1b8278aff14df2dacb5df2787d2eb8bdf;hp=022a1f0fdaec034c39ab99269411ecfefc4b31bf;hpb=fa3a1d1452d3bcace6bf3abea292ff985a9bd3d3;p=virtualjaguar

diff --git a/docs/INSTALL b/docs/INSTALL
index 022a1f0..c81b0a5 100644
--- a/docs/INSTALL
+++ b/docs/INSTALL
@@ -1,44 +1,75 @@
----------------------------------------------
-Virtual Jaguar v1.0.7 GCC/SDL release INSTALL
----------------------------------------------
+----------------------------------------
+Virtual Jaguar v2.1.1 Qt release INSTALL
+----------------------------------------
 
 
 REQUIREMENTS:
 -------------
 
-To compile Virtual Jaguar you need to check if you have the minimum
-requirements for compiling the sources:
+The minimum requirements for compiling Virtual Jaguar from source are:
 
-- GCC v2.95 or v3.x;
-- SDL v1.2.5 or higher;
-- ZLIB v1.1.4
-- OpenGL libraries
-- supported OS (BeOS, Linux, FreeBSD and WIN32 through mingw); other OSs may
-  work to but you may need to change some items in the Makefile and compile
-  script.
-
-Optionally you need a Atari Jaguar boot ROM (and/or CD boot ROM) which is
-available on the Internet. We can't include the boot ROM since it's still
-copyrighted.
+ o  GCC v4.4.x or higher
+ o  SDL v1.2.14 or higher
+ o  zlib v1.2.5
+ o  libcdio v0.90 or higher (optional, for Jaguar CD support)
+ o  OpenGL libraries
+ o  Qt 4.7.3 or higher (but not Qt 5!)
+ o  supported OS (BeOS, Linux, FreeBSD and WIN32 through mingw, MacOS); other
+    OSs may work to but you may need to change some items in the Makefile.
 
 
 COMPILING:
 ----------
 
-If you sure you have the minimum software requirements, you can safely compile
+Assuming that you meet the minimum software requirements, you can compile
 Virtual Jaguar by issuing the following command in the directory where you
 decompressed the source:
 
-./compile
+make
+
+Optionally you can manually strip virtualjaguar[.exe] to downsize the binary.
+You can also run upx on the binary as well and you'll end up with a somewhat
+smaller binary.
+
+That's it! You can now start the emulator with ./virtualjaguar. See the built
+in help (Help|Contents) for more info.
+
+For even more info, go to http://icculus.org/virtualjaguar.
+
+
+NOTES FOR COMPILING UNDER MAC OSX:
+----------------------------------
+
+All is not well in Appleland, but we can help. Apple, in their infinite wisdom,
+has decided not to ship a compiler and tools to build software. So first of all
+you need to download and install 'Command Line Tools for XCode'. Then, to
+compile the bare minimum app under OSX requires libsdl and Qt; however, these
+must be made statically and installed "the unix way". What that means is you
+have to download and unpack the source directories, then make and install them
+from the terminal. For libsdl, this is as simple as doing:
+
+./configure
+make
+sudo make install
+
+libsdl makes both static *and* shared libs and installs both. Making Qt takes a
+bit longer (timewise), but requires not much user intervention to get things
+going. Basically, you do:
+
+./configure -static -no-webkit -no-qt3support -no-framework -no-exceptions -nomake examples -nomake demos
+make
+sudo make install
+
+Be forewarned that it will use around 20 GB of disk space to build, and another
+20 GB for the install! Once libsdl and Qt have been made and installed, you can
+now go into the folder where the Virtual Jaguar source is and do:
+
+make
 
-Optionally you can manually strip vj[.exe] to downsize the binary. If you have
-upx in your path somewhere, you can uncomment the line in the makefile that
-executes upx so that you'll end up with a somewhat smaller binary.
- 
-That's it! You're done! You can now start the emulator with ./vj. See the
-output for more details or consult the README file for more info.
+Assuming all went well, you should now have a nice shiny new virtualjaguar.app
+in that folder. Depending on how old your copy of OSX is, you might have to
+copy a qt_menu.nib into the app bundle like so:
 
-For even more info, go to http://sdlemu.ngemu.com or send use an e-mail to the
-following e-mail address: sdlemu AT ngemu DOT com.
+cp -r ~/location-where-you-built-qt/src/gui/mac/qt_menu.nib virtualjaguar.app/Contents/Resources/
 
-SDLEMU
+Have fun!