INSTALL.txt 5.6 KB

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