INSTALL
author Ryan C. Gordon <icculus@icculus.org>
Fri, 24 May 2002 03:37:42 +0000
changeset 230 13e275b51d5a
parent 214 19846c18071b
child 283 c966316c8998
permissions -rw-r--r--
Updated.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
214
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     1
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
     2
 -----------------------------------------------------------------------------
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
     3
   Please note that the win32 and macos support files are out of date, but
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
     4
   will be corrected shortly.  --ryan.
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
     5
 -----------------------------------------------------------------------------
214
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     6
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     7
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     8
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
     9
Building is (ahem) very easy.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    10
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    11
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    12
ALL PLATFORMS:
91
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    13
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    14
Please understand your rights and mine: read the text file LICENSE in the root
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    15
of the source tree. If you can't abide by it, delete this source tree now.
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    16
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    17
The best documentation for the PhysicsFS API is physfs.h. It is VERY heavily
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    18
commented, and makes an excellent, in-depth reference to all the functions.
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    19
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    20
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    21
UNIX and BeOS:
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    22
(If you got this code from CVS, run "./bootstrap" first.)
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    23
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    24
Run ./configure --help and see what features can be optionally enabled or
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    25
disabled. "./configure" does its best to pick optimal defaults for your
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    26
platform.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    27
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    28
Run "make".
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    29
As root, run "make install".
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    30
If you get sick of the library, run "make uninstall" as root and it will
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    31
remove all traces of the library from the system paths.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    32
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    33
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    34
WIN32:
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    35
If building with CygWin, follow the Unix instructions, above.
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    36
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    37
Otherwise, get http://icculus.org/physfs/downloads/physfs-win32-support.zip,
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    38
and unpack in the root of the source directory, preserving directory names. If
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    39
you did it correctly, there should be a file named "physfs.dsp" in the
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    40
same directory as "physfs.h". That zipfile has Visual C project files for
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    41
Visual Studio 6.0 and Visual Studio .NET. If you're using Visual C, point the
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    42
IDE at physfs.dsp, and build. If you're using any other compiler, send me a
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    43
patch when you get it working.  :)
89
2f9f1d02aaca Updated win32 build instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 71
diff changeset
    44
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    45
IMPORTANT: If you are using anything older than Visual Studio.NET, you
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    46
will _NEED_ to upgrade to the latest Platform SDK from Microsoft. It is a
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    47
free download: http://www.microsoft.com/msdownload/platformsdk/sdkupdate/
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    48
Be sure to install _at least_ the Core SDK and the WMI SDK. Even though you
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    49
need these SDK updates, the compiled PhysicsFS DLL should work on any win32
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    50
platform from Win95 and WinNT 4.0 and later. IF YOU ARE MISSING CONSTANTS
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    51
AND/OR THE PROJECT REFUSES TO LINK, YOUR PLATFORM SDK IS OUT OF DATE. Do _not_
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    52
complain to us. Suck it up and upgrade your libraries.
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    53
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    54
No one's tried building this for a WinCE (PocketPC) platform, but it may or
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    55
may not work. Patches are welcome.
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    56
91
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    57
If someone is willing to maintain prebuilt PhysicsFS DLLs, I'd like to hear
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    58
from you; send an email to icculus@clutteredmind.org.
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    59
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    60
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    61
MACOS 8/9:
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    62
Download http://icculus.org/physfs/downloads/mac_classic_support.sit and 
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    63
unpack it in the root of the physfs folder. It should produce a folder 
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    64
called "Mac Classic Support" that has CodeWarrior 6 project files.
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    65
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    66
If someone is willing to maintain prebuilt PhysicsFS Shared Libraries for
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    67
the Mac, I'd like to hear from you; send an email to icculus@clutteredmind.org.
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    68
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    69
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    70
OTHER PLATFORMS:
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    71
Many platforms, such as Solaris and MacOS X, might "just work" with the Unix
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    72
autoconf tools. Some of these platforms are known to have worked at one time,
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    73
but have not been heavily tested, if tested at all. To implement a new
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    74
platform or archiver, please read the heavily-commented physfs_internal.h
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    75
and look in the platform/ and archiver/ directories for examples.
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    76
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    77
--ryan. (icculus@clutteredmind.org)
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    78