INSTALL

   1
   2 GNUBOY INSTALLATION
   3
   4
   5   *NIX SYSTEMS
   6
   7 One or more of the following is required to compile on *nix: X, SDL,
   8 svgalib, or Linux fbcon. Since basically everyone has X, this should
   9 not be a problem. Please note that the SDL and fbcon ports are the
  10 most functional, however. In the future, Sun console may also be
  11 supported.
  12
  13 The best and easiest way to build gnuboy for *nix is with the
  14 configure script:
  15
  16   ./configure
  17   make
  18   make install
  19
  20 By default, heavy optimization and asm cpu and graphics cores will be
  21 used if available on your platform. For information on compiletime
  22 options related to performance and debugging, type:
  23
  24   ./configure --help
  25
  26 Alternatively, if you don't like the GNU configure script, you may
  27 copy the Makefile.nix to Makefile and edit it by hand to work with
  28 your system. Make sure you uncomment -DIS_LITTLE_ENDIAN if your cpu is
  29 little endian. Please note that not everything is supported when
  30 compiling this way, and that it should only be done as a last resort.
  31 The generic Makefile.nix may be removed in the future since it's extra
  32 work to maintain.
  33
  34 Running make should produce the binaries xgnuboy, fbgnuboy, sgnuboy
  35 and/or sdlgnuboy, depending on the availability of the various
  36 interface libraries on your host.  The install target will install
  37 these to $(prefix)/bin, where prefix is specified to configure in the
  38 usual way. The default prefix is of course /usr/local/.
  39
  40 Binary packages may be available for some platforms, but they are
  41 usually not quite up to date, and are not built or supported by the
  42 gnuboy team.
  43
  44 Binary package maintainers should be aware that, by default, gnuboy
  45 will be built with optimizations specific to the exact host cpu it's
  46 being compiled on, and may not work on older models. If you want your
  47 binaries to work with older systems too, run configure with the
  48 --disable-arch option to disable architecture specific compiler flags.
  49
  50
  51   WINDOWS
  52
  53 Mingw32 and the SDL development files are required to compile gnuboy
  54 for Windows. They may be obtained from www.mingw.org and
  55 www.libsdl.org, respectively.
  56
  57 Just copy Makefile.mingw32 to Makefile and run make. When done, put
  58 the resulting gnuboy.exe wherever you wish to install it.
  59
  60 Precompiled binaries are also available for Windows; check the site
  61 from which you obtained gnuboy to see if it provides copies.
  62
  63
  64   DOS
  65
  66 You'll need djgpp to use the included Makefile. Theoretically it
  67 shouldn't be hard to port the dos-specific modules to work with other
  68 compilers, but I see no reason why it should be necessary.
  69
  70 Since all DOS systems are basically alike, just copy Makefile.dos to
  71 Makefile and type "make" to compile gnuboy. No configuration should be
  72 necessary. If you do have build problems, let us know.
  73
  74 After compiling, place gnuboy.exe wherever you want.
  75
  76 Precompiled binaries are also available for DOS; check the site from
  77 which you obtained gnuboy to see if it provides copies.
  78
  79
  80
  81