src/unison/physfs-1.1.1/INSTALL.txt

   1
   2 The latest PhysicsFS information and releases can be found at:
   3   http://icculus.org/physfs/
   4
   5 Building is (ahem) very easy.
   6
   7
   8 ALL PLATFORMS:
   9
  10 Please understand your rights and mine: read the text file LICENSE.txt in the
  11  root of the source tree. If you can't abide by it, delete this source tree
  12  now. The license is extremely liberal, even to closed-source, commercial
  13  applications.
  14
  15 If you've got Doxygen (http://www.doxygen.org/) installed, you can run it
  16  without any command line arguments in the root of the source tree to generate
  17  the API reference (or build the "docs" target from your build system). This
  18  is optional. You can browse the API docs online here:
  19
  20     http://icculus.org/physfs/docs/
  21
  22
  23
  24
  25 UNIX:
  26
  27 You will need CMake (http://www.cmake.org/) 2.4 or later installed.
  28
  29 Run "cmake ." in the root of the source directory to generate Makefiles.
  30  You can then run "ccmake ." and customize the build, but the defaults are
  31  probably okay. You can have CMake generate KDevelop project files if you
  32  prefer these.
  33
  34 Run "make". PhysicsFS will now build.
  35
  36 As root, run "make install".
  37  If you get sick of the library, run "xargs rm < install_manifest.txt" as root
  38  and it will remove all traces of the library from the system paths.
  39
  40 Primary Unix development is done with GNU/Linux, but PhysicsFS is known to
  41  work out of the box with several flavors of Unix. It it doesn't work, patches
  42  to get it running can be sent to icculus@icculus.org.
  43
  44
  45
  46 BeOS:
  47
  48 Use the "Unix" instructions, above. The CMake port to BeOS is fairly new at
  49  the time of this writing, but it works. You can get a build of CMake from
  50  bebits.com or build it yourself from source from cmake.org.
  51
  52
  53
  54 Windows:
  55
  56 If building with CygWin, mingw32 or something else that uses the GNU
  57  toolchain, follow the Unix instructions, above.
  58
  59 If you want to use Visual Studio, nmake, or the Platform SDK, you will need
  60  CMake (http://www.cmake.org/) 2.4 or later installed. Point CMake at the
  61  CMakeLists.txt file in the root of the source directory and hit the
  62  "Configure" button. After telling it what type of compiler you are targeting
  63  (Borland, Visual Studio, etc), CMake will process for while and then give you
  64  a list of options you can change (what archivers you want to support, etc).
  65  If you aren't sure, the defaults are probably fine. Hit the "Configure"
  66  button again, then "OK" once configuration has completed with options that
  67  match your liking. Now project files for your favorite programming
  68  environment will be generated for you in the directory you specified.
  69  Go there and use them to build PhysicsFS.
  70
  71 PhysicsFS will only link directly against system libraries that have existed
  72  since Windows 95 and Windows NT 3.51. If there's a newer API we want to use,
  73  we try to dynamically load it at runtime and fallback to a reasonable
  74  behaviour when we can't find it...this is used for Unicode support and
  75  locating user-specific directories, etc.
  76
  77 PhysicsFS has not been tested on 64-bit Windows, but probably works. There is
  78  no 16-bit Windows support at all. Reports of success and problems can go to
  79  Ryan at icculus@icculus.org ...
  80
  81 If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
  82 from you; send an email to icculus@icculus.org ...
  83
  84
  85
  86 PocketPC/WindowsCE:
  87
  88 Code exists for PocketPC support, and there are shipping titles that used
  89  PhysicsFS 1.0 on PocketPC...but it isn't tested in 2.0, and is probably
  90  broken with the new build system. Please send patches.
  91
  92
  93
  94 MAC OS 8/9:
  95
  96 Classic Mac OS support has been dropped in PhysicsFS 2.0. Apple hasn't updated
  97  pre-OSX versions in almost a decade at this point, none of the hardware
  98  they've shipped will boot it for almost as many years, and finding
  99  developer tools for it is becoming almost impossible. As the switch to Intel
 100  hardware has removed the "Classic" emulation environment, it was time to
 101  remove support from PhysicsFS. That being said, the PhysicsFS 1.0 branch can
 102  still target back to Mac OS 8.5, so you can use that if you need support for
 103  this legacy OS. We still very much support Mac OS X, though: see below.
 104
 105
 106
 107 MAC OS X:
 108
 109 You will need CMake (http://www.cmake.org/) 2.4 or later installed.
 110
 111 You can either generate a Unix makefile with CMake, or generate an Xcode
 112  project, whichever makes you more comfortable.
 113
 114 PowerPC and Intel Macs should both be supported.
 115
 116 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
 117  Mac OS X, I'd like to hear from you; send an email to icculus@icculus.org.
 118
 119
 120
 121 OS/2:
 122
 123 You need Innotek GCC and libc installed (or kLIBC). I tried this on a stock
 124  Warp 4 install, no fixpaks. You need to install link386.exe (Selective
 125  Install, "link object modules" option). Once klibc and GCC are installed
 126  correctly, unpack the source to PhysicsFS and run the script
 127  file "makeos2.cmd". I know this isn't ideal, but I wanted to have this build
 128  without users having to hunt down a "make" program.
 129
 130 Someone please port CMake to OS/2. Ideally I'd like to be able to target
 131  Innotek GCC and OpenWatcom with CMake.
 132
 133 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
 134  OS/2, I'd like to hear from you; send an email to icculus@icculus.org.
 135
 136
 137
 138 OTHER PLATFORMS:
 139
 140 Many Unix-like platforms might "just work" with CMake. Some of these platforms
 141  are known to have worked at one time, but have not been heavily tested, if
 142  tested at all. PhysicsFS is, as far as we know, 64-bit and byteorder clean,
 143  and is known to compile on several compilers across many platforms. To
 144  implement a new platform or archiver, please read the heavily-commented
 145  physfs_internal.h and look in the platform/ and archiver/ directories for
 146  examples.
 147
 148 --ryan. (icculus@icculus.org)
 149