INSTALL
changeset 283 c966316c8998
parent 230 13e275b51d5a
child 488 731e85d74cfe
equal deleted inserted replaced
282:3d213c035cb1 283:c966316c8998
     1 
     1 
     2  -----------------------------------------------------------------------------
     2 The latest PhysicsFS information and releases can be found at:
     3    Please note that the win32 and macos support files are out of date, but
     3   http://icculus.org/physfs/
     4    will be corrected shortly.  --ryan.
       
     5  -----------------------------------------------------------------------------
       
     6 
       
     7 
       
     8 
     4 
     9 Building is (ahem) very easy.
     5 Building is (ahem) very easy.
    10 
     6 
    11 
     7 
    12 ALL PLATFORMS:
     8 ALL PLATFORMS:
    13 
     9 
    14 Please understand your rights and mine: read the text file LICENSE in the root
    10 Please understand your rights and mine: read the text file LICENSE in the root
    15 of the source tree. If you can't abide by it, delete this source tree now.
    11 of the source tree. If you can't abide by it, delete this source tree now.
    16 
    12 
    17 The best documentation for the PhysicsFS API is physfs.h. It is VERY heavily
    13 If you've got Doxygen (http://www.doxygen.org/) installed, you can run it
    18 commented, and makes an excellent, in-depth reference to all the functions.
    14  without any command line arguments in the root of the source tree to generate
       
    15  the API reference. This is optional. You can browse the API docs online
       
    16  here:  http://icculus.org/physfs/docs/
       
    17 
    19 
    18 
    20 
    19 
    21 UNIX and BeOS:
    20 UNIX and BeOS:
    22 (If you got this code from CVS, run "./bootstrap" first.)
    21 (If you got this code from CVS, run "./bootstrap" first.)
    23 
    22 
    28 Run "make".
    27 Run "make".
    29 As root, run "make install".
    28 As root, run "make install".
    30 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
    31 remove all traces of the library from the system paths.
    30 remove all traces of the library from the system paths.
    32 
    31 
       
    32 BeOS doesn't seem to be building shared libraries with the version of
       
    33 autoconf/automake I used (even though it swears it did). If anyone has some
       
    34 insight into this, I'd like to hear from you.
       
    35 
       
    36 
    33 
    37 
    34 WIN32:
    38 WIN32:
    35 If building with CygWin, follow the Unix instructions, above.
    39 If building with CygWin, mingw32 or something else that uses the GNU
       
    40 toolchain, follow the Unix instructions, above.
    36 
    41 
    37 Otherwise, get http://icculus.org/physfs/downloads/physfs-win32-support.zip,
    42 Point Visual Studio 6.0 at "physfs.dsp" in the root of the source tree, and
    38 and unpack in the root of the source directory, preserving directory names. If
    43 build. This will produce a "physfs.dll" and "physfs.lib" (shared library and
    39 you did it correctly, there should be a file named "physfs.dsp" in the
    44 import lib, respectively) in either a "Debug" or "Release" directory,
    40 same directory as "physfs.h". That zipfile has Visual C project files for
    45 depending on what configuration you chose to build. After building the lib,
    41 Visual Studio 6.0 and Visual Studio .NET. If you're using Visual C, point the
    46 you can make sure it works by building the "test_physfs.dsp" project file,
    42 IDE at physfs.dsp, and build. If you're using any other compiler, send me a
    47 which will create "test_physfs.exe" in "Debug" or "Release". This EXE is
    43 patch when you get it working.  :)
    48 linked against the DLL you built previously.
    44 
    49 
    45 IMPORTANT: If you are using anything older than Visual Studio.NET, you
    50 Visual Studio.NET probably handles these files, but we'll have honest-to-god
    46 will _NEED_ to upgrade to the latest Platform SDK from Microsoft. It is a
    51 .vcproj files in the next official release.
    47 free download: http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
    52 
    48 Be sure to install _at least_ the Core SDK and the WMI SDK. Even though you
    53 If you're using another compiler, send me a patch when you get it working.  :)
    49 need these SDK updates, the compiled PhysicsFS DLL should work on any win32
       
    50 platform from Win95 and WinNT 4.0 and later. IF YOU ARE MISSING CONSTANTS
       
    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.
       
    53 
    54 
    54 No one's tried building this for a WinCE (PocketPC) platform, but it may or
    55 No one's tried building this for a WinCE (PocketPC) platform, but it may or
    55 may not work. Patches are welcome.
    56 may not work. Patches are welcome.
    56 
    57 
    57 If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
    58 If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
    58 from you; send an email to icculus@clutteredmind.org.
    59 from you; send an email to icculus@clutteredmind.org.
    59 
    60 
    60 
    61 
       
    62 
    61 MACOS 8/9:
    63 MACOS 8/9:
    62 Download http://icculus.org/physfs/downloads/mac_classic_support.sit and 
    64 Double-click on "CWProjects.sit" in the root of the source tree. This will
    63 unpack it in the root of the physfs folder. It should produce a folder 
    65 unpack into a folder called "Mac Classic Support", which has CodeWarrior 6
    64 called "Mac Classic Support" that has CodeWarrior 6 project files.
    66 project files.
       
    67 
       
    68 Point CodeWarrior at "physfs.mcp" in that new folder, and build. This will
       
    69 produce a "PhysicsFS" or "PhysicsFS Debug" shared library, depending on what
       
    70 configuration you chose to build. After building the lib, you can make sure
       
    71 it works by building the "test_physfs.mcp" project file, which will create
       
    72 "test_physfs" or "test_physfs Debug". These binaries are linked against the
       
    73 DLLs you built previously.
    65 
    74 
    66 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
    75 If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
    67 the Mac, I'd like to hear from you; send an email to icculus@clutteredmind.org.
    76 the Mac, I'd like to hear from you; send an email to icculus@clutteredmind.org.
    68 
    77 
    69 
    78 
       
    79 
       
    80 MACOS X:
       
    81 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
       
    83 "no input files" then you've got the tools installed.
       
    84 
       
    85 From a terminal, run "./configure --disable-shared --enable-static". Run
       
    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 
       
    92 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.
       
    94 
       
    95 
       
    96 
    70 OTHER PLATFORMS:
    97 OTHER PLATFORMS:
    71 Many platforms, such as Solaris and MacOS X, might "just work" with the Unix
    98 Many Unix-like platforms might "just work" with the GNU autoconf tools. Some
    72 autoconf tools. Some of these platforms are known to have worked at one time,
    99 of these platforms are known to have worked at one time, but have not been
    73 but have not been heavily tested, if tested at all. To implement a new
   100 heavily tested, if tested at all. To implement a new platform or archiver,
    74 platform or archiver, please read the heavily-commented physfs_internal.h
   101 please read the heavily-commented physfs_internal.h and look in the platform/
    75 and look in the platform/ and archiver/ directories for examples.
   102 and archiver/ directories for examples.
    76 
   103 
    77 --ryan. (icculus@clutteredmind.org)
   104 --ryan. (icculus@clutteredmind.org)
    78 
   105