INSTALL
changeset 488 731e85d74cfe
parent 283 c966316c8998
child 590 171fd8b3f7f2
equal deleted inserted replaced
487:06d6072829ae 488:731e85d74cfe
    15  the API reference. This is optional. You can browse the API docs online
    15  the API reference. This is optional. You can browse the API docs online
    16  here:  http://icculus.org/physfs/docs/
    16  here:  http://icculus.org/physfs/docs/
    17 
    17 
    18 
    18 
    19 
    19 
    20 UNIX and BeOS:
    20 UNIX:
    21 (If you got this code from CVS, run "./bootstrap" first.)
    21 (If you got this code from CVS, run "./bootstrap" first.)
    22 
    22 
    23 Run ./configure --help and see what features can be optionally enabled or
    23 Run ./configure --help and see what features can be optionally enabled or
    24 disabled. "./configure" does its best to pick optimal defaults for your
    24 disabled. "./configure" does its best to pick optimal defaults for your
    25 platform.
    25 platform.
    27 Run "make".
    27 Run "make".
    28 As root, run "make install".
    28 As root, run "make install".
    29 If you get sick of the library, run "make uninstall" as root and it will
    29 If you get sick of the library, run "make uninstall" as root and it will
    30 remove all traces of the library from the system paths.
    30 remove all traces of the library from the system paths.
    31 
    31 
    32 BeOS doesn't seem to be building shared libraries with the version of
    32 Primary Unix development is done with GNU/Linux, but PhysicsFS is known to
    33 autoconf/automake I used (even though it swears it did). If anyone has some
    33 work out of the box with several flavors of Unix. It it doesn't work, patches
    34 insight into this, I'd like to hear from you.
    34 to get it running can be sent to icculus@clutteredmind.org.
    35 
    35 
       
    36 
       
    37 BeOS:
       
    38 Use the "Unix" instructions, above.
       
    39 
       
    40 
       
    41 AtheOS:
       
    42 Use the "Unix" instructions, above.
    36 
    43 
    37 
    44 
    38 WIN32:
    45 WIN32:
    39 If building with CygWin, mingw32 or something else that uses the GNU
    46 If building with CygWin, mingw32 or something else that uses the GNU
    40 toolchain, follow the Unix instructions, above.
    47 toolchain, follow the Unix instructions, above.
    41 
    48 
    42 Point Visual Studio 6.0 at "physfs.dsp" in the root of the source tree, and
    49 If you're using Visual C++ 6, point it at "physfs.dsp" in the root of the
    43 build. This will produce a "physfs.dll" and "physfs.lib" (shared library and
    50 source tree, and build. This will produce a "physfs.dll" and "physfs.lib"
    44 import lib, respectively) in either a "Debug" or "Release" directory,
    51 (shared library and import lib, respectively) in either a "Debug" or
    45 depending on what configuration you chose to build. After building the lib,
    52 "Release" directory, depending on what configuration you chose to build.
    46 you can make sure it works by building the "test_physfs.dsp" project file,
    53 After building the lib, you can make sure it works by building the
    47 which will create "test_physfs.exe" in "Debug" or "Release". This EXE is
    54 "test_physfs.dsp" project file, which will create "test_physfs.exe" in
    48 linked against the DLL you built previously.
    55 "Debug" or "Release". This EXE is linked against the DLL you built
       
    56 previously.
    49 
    57 
    50 Visual Studio.NET probably handles these files, but we'll have honest-to-god
    58 Visual Studio.NET users should do the same thing, but use the "physfs.vcproj"
    51 .vcproj files in the next official release.
    59 and "test_physfs.vcproj" project files instead.
    52 
    60 
    53 If you're using another compiler, send me a patch when you get it working.  :)
    61 If you're using another compiler, send me a patch when you get it working.  :)
    54 
    62 
    55 No one's tried building this for a WinCE (PocketPC) platform, but it may or
    63 No one's tried building this for a WinCE (PocketPC) platform, but it may or
    56 may not work. Patches are welcome.
    64 may not work. Patches are welcome.
    80 MACOS X:
    88 MACOS X:
    81 You (currently) need to use the freeware Apple Developer Tools, which are
    89 You (currently) need to use the freeware Apple Developer Tools, which are
    82 based on the GNU toolchain. Fire up a terminal and run "cc"...if this reports
    90 based on the GNU toolchain. Fire up a terminal and run "cc"...if this reports
    83 "no input files" then you've got the tools installed.
    91 "no input files" then you've got the tools installed.
    84 
    92 
    85 From a terminal, run "./configure --disable-shared --enable-static". Run
    93 Follow the Unix directions, above (configure, make, make install).
    86 "make". This will get you a static library and a "test_physfs" binary.
       
    87 
       
    88 I would love for someone to fix this so it will build shared libraries (since
       
    89 static libraries make it awkward to deal with the license terms), or send me
       
    90 Project Builder libraries.
       
    91 
    94 
    92 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
    95 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
    93 MacOS X, I'd like to hear from you; send an email to icculus@clutteredmind.org.
    96 MacOS X, I'd like to hear from you; send an email to icculus@clutteredmind.org.
    94 
    97 
    95 
    98 
       
    99 OS/2:
       
   100 You need EMX installed. I tried this on a stock Warp 4 install, no fixpaks.
       
   101 I used the latest EMX and patches (which are several years old now). You need
       
   102 to install link386.exe (Selective Install, "link object modules" option). Once
       
   103 EMX is installed correctly, unpack the source to PhysicsFS and run the script
       
   104 file "makeos2.cmd". I know this isn't ideal, but I wanted to have this build
       
   105 without users having to hunt down a "make" program (While several exist, EMX
       
   106 doesn't come with one). If someone wants to hack some REXX to make this a bit
       
   107 more piccky about recompiling, I'll accept the patch.
       
   108 
       
   109 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
       
   110 OS/2, I'd like to hear from you; send an email to icculus@clutteredmind.org.
       
   111 
    96 
   112 
    97 OTHER PLATFORMS:
   113 OTHER PLATFORMS:
    98 Many Unix-like platforms might "just work" with the GNU autoconf tools. Some
   114 Many Unix-like platforms might "just work" with the GNU autoconf tools. Some
    99 of these platforms are known to have worked at one time, but have not been
   115 of these platforms are known to have worked at one time, but have not been
   100 heavily tested, if tested at all. To implement a new platform or archiver,
   116 heavily tested, if tested at all. PhysicsFS is, as far as we know, 64-bit and
   101 please read the heavily-commented physfs_internal.h and look in the platform/
   117 byteorder clean, and is known to compile on several compilers across many
   102 and archiver/ directories for examples.
   118 platforms. To implement a new platform or archiver, please read the
       
   119 heavily-commented physfs_internal.h and look in the platform/ and archiver/
       
   120 directories for examples.
   103 
   121 
   104 --ryan. (icculus@clutteredmind.org)
   122 --ryan. (icculus@clutteredmind.org)
   105 
   123