INSTALL
changeset 230 13e275b51d5a
parent 214 19846c18071b
child 283 c966316c8998
equal deleted inserted replaced
229:31def24e2a83 230:13e275b51d5a
     1 ------------------------------------------------------------------------------
       
     2 
     1 
     3 NOTE: THESE INSTRUCTIONS NEED TO BE UPDATED FOR THE NEW BUILD SYSTEM. THIS
     2  -----------------------------------------------------------------------------
     4  AFFECTS UNIX, WIN32 AND MACOS!
     3    Please note that the win32 and macos support files are out of date, but
     5 
     4    will be corrected shortly.  --ryan.
     6 Please bitch to Ryan (icculus@clutteredmind.org) until he updates this.
     5  -----------------------------------------------------------------------------
     7 
       
     8 ------------------------------------------------------------------------------
       
     9 
     6 
    10 
     7 
    11 
     8 
    12 Building is (ahem) very easy.
     9 Building is (ahem) very easy.
    13 
    10 
    19 
    16 
    20 The best documentation for the PhysicsFS API is physfs.h. It is VERY heavily
    17 The best documentation for the PhysicsFS API is physfs.h. It is VERY heavily
    21 commented, and makes an excellent, in-depth reference to all the functions.
    18 commented, and makes an excellent, in-depth reference to all the functions.
    22 
    19 
    23 
    20 
    24 UNIX:
    21 UNIX and BeOS:
       
    22 (If you got this code from CVS, run "./bootstrap" first.)
    25 
    23 
    26 Edit "Makefile", and follow the instructions. The defaults are probably okay
    24 Run ./configure --help and see what features can be optionally enabled or
    27 for general purposes, but give it a once over to make sure. If you don't have
    25 disabled. "./configure" does its best to pick optimal defaults for your
    28 zLib on your system, you'll need to disable ZIP support.
    26 platform.
    29 
    27 
    30 run "make"
    28 Run "make".
    31 
    29 As root, run "make install".
    32 That's it. The library will be sitting in a new directory called "bin".
    30 If you get sick of the library, run "make uninstall" as root and it will
    33 
    31 remove all traces of the library from the system paths.
    34 Run "make install" to install the library for use on your system.
       
    35 
    32 
    36 
    33 
    37 WIN32:
    34 WIN32:
    38 Download http://icculus.org/physfs/downloads/physfs-win32-support.zip, and
    35 If building with CygWin, follow the Unix instructions, above.
    39 unpack in the root of the source directory, preserving directory names. If
    36 
    40 you did it correctly, there should be a directory named "zlib114" in the
    37 Otherwise, get http://icculus.org/physfs/downloads/physfs-win32-support.zip,
    41 same directory as "physfs.h". This archive has Visual C project files and
    38 and unpack in the root of the source directory, preserving directory names. If
    42 the code needed for zipfile support in PhysicsFS, since most Windows boxes
    39 you did it correctly, there should be a file named "physfs.dsp" in the
    43 don't have zlib preinstalled.
    40 same directory as "physfs.h". That zipfile has Visual C project files for
       
    41 Visual Studio 6.0 and Visual Studio .NET. If you're using Visual C, point the
       
    42 IDE at physfs.dsp, and build. If you're using any other compiler, send me a
       
    43 patch when you get it working.  :)
    44 
    44 
    45 IMPORTANT: If you are using anything older than Visual Studio.NET, you
    45 IMPORTANT: If you are using anything older than Visual Studio.NET, you
    46 will _NEED_ to upgrade to the latest Platform SDK from Microsoft. It is a
    46 will _NEED_ to upgrade to the latest Platform SDK from Microsoft. It is a
    47 free download: http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
    47 free download: http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
    48 Be sure to install _at least_ the Core SDK and the WMI SDK. I'm not sure if
    48 Be sure to install _at least_ the Core SDK and the WMI SDK. Even though you
    49 this is needed (or usable for Cygwin). Even though you need these SDK updates,
    49 need these SDK updates, the compiled PhysicsFS DLL should work on any win32
    50 the compiled PhysicsFS DLL should work on any win32 platform from Win95 and
    50 platform from Win95 and WinNT 4.0 and later. IF YOU ARE MISSING CONSTANTS
    51 WinNT 4.0 and later.
    51 AND/OR THE PROJECT REFUSES TO LINK, YOUR PLATFORM SDK IS OUT OF DATE. Do _not_
       
    52 complain to us. Suck it up and upgrade your libraries.
    52 
    53 
    53 No one's tried building this for a WinCE (PocketPC) platform, but it may or
    54 No one's tried building this for a WinCE (PocketPC) platform, but it may or
    54 may not work. Patches are welcome.
    55 may not work. Patches are welcome.
    55 
       
    56 After that, if building with CygWin, follow the Unix instructions, above.
       
    57 (Which used to work, see caveat about Platform SDK above). If you're using
       
    58 Visual C, point the IDE at physfs.dsp, and build. If you're using any other
       
    59 compiler, send me a patch when you get it working.  :)
       
    60 
    56 
    61 If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
    57 If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
    62 from you; send an email to icculus@clutteredmind.org.
    58 from you; send an email to icculus@clutteredmind.org.
    63 
    59 
    64 
    60 
    65 MACOS 8/9:
    61 MACOS 8/9:
    66 Download http://icculus.org/physfs/downloads/mac_classic_support.sit and 
    62 Download http://icculus.org/physfs/downloads/mac_classic_support.sit and 
    67 unpack it in the root of the physfs folder. It should produce a folder 
    63 unpack it in the root of the physfs folder. It should produce a folder 
    68 called "Mac Classic Support" that has CodeWarrior 6 project files and a 
    64 called "Mac Classic Support" that has CodeWarrior 6 project files.
    69 copy of zlib for zipfile support.
       
    70 
    65 
    71 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
    66 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
    72 the Mac, I'd like to hear from you; send an email to icculus@clutteredmind.org.
    67 the Mac, I'd like to hear from you; send an email to icculus@clutteredmind.org.
    73 
    68 
    74 
    69 
    75 OTHER PLATFORMS:
    70 OTHER PLATFORMS:
    76 Many platforms might "just work" with the Unix Makefile (such as BeOS and 
    71 Many platforms, such as Solaris and MacOS X, might "just work" with the Unix
    77 MacOS X), but have not been heavily tested, if tested at all. To implement a
    72 autoconf tools. Some of these platforms are known to have worked at one time,
    78 new platform or archiver, please read the heavily-commented physfs_internal.h
    73 but have not been heavily tested, if tested at all. To implement a new
       
    74 platform or archiver, please read the heavily-commented physfs_internal.h
    79 and look in the platform/ and archiver/ directories for examples.
    75 and look in the platform/ and archiver/ directories for examples.
    80 
    76 
    81 --ryan. (icculus@clutteredmind.org)
    77 --ryan. (icculus@clutteredmind.org)
    82 
    78