Shamusworld >> Repos - virtualjaguar/blob - docs/INSTALL

   1 ----------------------------------------
   2 Virtual Jaguar v2.1.1 Qt release INSTALL
   3 ----------------------------------------
   4
   5
   6 REQUIREMENTS:
   7 -------------
   8
   9 The minimum requirements for compiling Virtual Jaguar from source are:
  10
  11  o  GCC v4.4.x or higher
  12  o  SDL v1.2.14 or higher
  13  o  zlib v1.2.5
  14  o  libcdio v0.90 or higher (optional, for Jaguar CD support)
  15  o  OpenGL libraries
  16  o  Qt 4.7.3 or higher (but not Qt 5!)
  17  o  supported OS (BeOS, Linux, FreeBSD and WIN32 through mingw, MacOS); other
  18     OSs may work to but you may need to change some items in the Makefile.
  19
  20
  21 COMPILING:
  22 ----------
  23
  24 Assuming that you meet the minimum software requirements, you can compile
  25 Virtual Jaguar by issuing the following command in the directory where you
  26 decompressed the source:
  27
  28 make
  29
  30 Optionally you can manually strip virtualjaguar[.exe] to downsize the binary.
  31 You can also run upx on the binary as well and you'll end up with a somewhat
  32 smaller binary.
  33
  34 That's it! You can now start the emulator with ./virtualjaguar. See the built
  35 in help (Help|Contents) for more info.
  36
  37 For even more info, go to http://icculus.org/virtualjaguar.
  38
  39
  40 NOTES FOR COMPILING UNDER MAC OSX:
  41 ----------------------------------
  42
  43 All is not well in Appleland, but we can help. Apple, in their infinite wisdom,
  44 has decided not to ship a compiler and tools to build software. So first of all
  45 you need to download and install 'Command Line Tools for XCode'. Then, to
  46 compile the bare minimum app under OSX requires libsdl and Qt; however, these
  47 must be made statically and installed "the unix way". What that means is you
  48 have to download and unpack the source directories, then make and install them
  49 from the terminal. For libsdl, this is as simple as doing:
  50
  51 ./configure
  52 make
  53 sudo make install
  54
  55 libsdl makes both static *and* shared libs and installs both. Making Qt takes a
  56 bit longer (timewise), but requires not much user intervention to get things
  57 going. Basically, you do:
  58
  59 ./configure -static -no-webkit -no-qt3support -no-framework -no-exceptions -nomake examples -nomake demos
  60 make
  61 sudo make install
  62
  63 Be forewarned that it will use around 20 GB of disk space to build, and another
  64 20 GB for the install! Once libsdl and Qt have been made and installed, you can
  65 now go into the folder where the Virtual Jaguar source is and do:
  66
  67 make
  68
  69 Assuming all went well, you should now have a nice shiny new virtualjaguar.app
  70 in that folder. Depending on how old your copy of OSX is, you might have to
  71 copy a qt_menu.nib into the app bundle like so:
  72
  73 cp -r ~/location-where-you-built-qt/src/gui/mac/qt_menu.nib virtualjaguar.app/Contents/Resources/
  74
  75 Have fun!