INSTALL.txt 5.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  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. Make a directory, wherever you like. This will be your build directory.
  17. Chdir to your build directory. Run "cmake /where/i/unpacked/physfs" to
  18. generate Makefiles. You can then run "ccmake ." and customize the build,
  19. but the defaults are probably okay. You can have CMake generate KDevelop
  20. project files if you prefer these.
  21. Run "make". PhysicsFS will now build.
  22. As root, run "make install".
  23. If you get sick of the library, run "xargs rm < install_manifest.txt" as root
  24. and it will remove all traces of the library from the system paths.
  25. Once you are satisfied, you can delete the build directory.
  26. Primary Unix development is done with GNU/Linux, but PhysicsFS is known to
  27. work out of the box with several flavors of Unix. It it doesn't work, patches
  28. to get it running can be sent to icculus@icculus.org.
  29. BeOS, Zeta, and Haiku:
  30. Use the "Unix" instructions, above. The CMake port to BeOS is fairly new at
  31. the time of this writing, but it works. You can get a build of CMake from
  32. bebits.com or build it yourself from source from cmake.org.
  33. Windows:
  34. If building with Cygwin, mingw32, MSYS, or something else that uses the GNU
  35. toolchain, follow the Unix instructions, above.
  36. If you want to use Visual Studio, nmake, or the Platform SDK, you will need
  37. CMake (http://www.cmake.org/) 2.4 or later installed. Point CMake at the
  38. CMakeLists.txt file in the root of the source directory and hit the
  39. "Configure" button. After telling it what type of compiler you are targeting
  40. (Borland, Visual Studio, etc), CMake will process for while and then give you
  41. a list of options you can change (what archivers you want to support, etc).
  42. If you aren't sure, the defaults are probably fine. Hit the "Configure"
  43. button again, then "OK" once configuration has completed with options that
  44. match your liking. Now project files for your favorite programming
  45. environment will be generated for you in the directory you specified.
  46. Go there and use them to build PhysicsFS.
  47. PhysicsFS will only link directly against system libraries that have existed
  48. since Windows 95 and Windows NT 3.51. If there's a newer API we want to use,
  49. we try to dynamically load it at runtime and fallback to a reasonable
  50. behaviour when we can't find it...this is used for Unicode support and
  51. locating user-specific directories, etc.
  52. PhysicsFS works on 32-bit and 64-bit Windows. There is no 16-bit Windows
  53. support at all. Reports of success and problems can go to Ryan at
  54. icculus@icculus.org ...
  55. If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
  56. from you; send an email to icculus@icculus.org ...
  57. PocketPC/WindowsCE:
  58. Support for PocketPC was removed in PhysicsFS 2.1.0. This was known to work
  59. in the 1.0 releases, but wasn't tested in 2.0 and later. PhysicsFS is not
  60. known to work on Windows Phone 7 (the latest Microsoft mobile tech at the
  61. time of this writing).
  62. MAC OS 8/9:
  63. Classic Mac OS support has been dropped in PhysicsFS 2.0. Apple hasn't updated
  64. pre-OSX versions in more than a decade at this point, none of the hardware
  65. they've shipped will boot it for almost as many years, and finding
  66. developer tools for it is becoming almost impossible. As the switch to Intel
  67. hardware has removed the "Classic" emulation environment, it was time to
  68. remove support from PhysicsFS. That being said, the PhysicsFS 1.0 branch can
  69. still target back to Mac OS 8.5, so you can use that if you need support for
  70. this legacy OS. We still very much support Mac OS X, though: see below.
  71. MAC OS X:
  72. You will need CMake (http://www.cmake.org/) 2.4 or later installed.
  73. You can either generate a Unix makefile with CMake, or generate an Xcode
  74. project, whichever makes you more comfortable.
  75. PowerPC and Intel Macs should both be supported.
  76. If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
  77. Mac OS X, I'd like to hear from you; send an email to icculus@icculus.org.
  78. OS/2:
  79. Support for OS/2 was removed in PhysicsFS 2.1. PhysicsFS 2.0 can still target
  80. this platform.
  81. OTHER PLATFORMS:
  82. Many Unix-like platforms might "just work" with CMake. Some of these platforms
  83. are known to have worked at one time, but have not been heavily tested, if
  84. tested at all. PhysicsFS is, as far as we know, 64-bit and byteorder clean,
  85. and is known to compile on several compilers across many platforms. To
  86. implement a new platform or archiver, please read the heavily-commented
  87. physfs_internal.h and look in the platform/ and archiver/ directories for
  88. examples.
  89. --ryan. (icculus@icculus.org)