INSTALL
author Ryan C. Gordon <icculus@icculus.org>
Fri, 10 May 2002 09:25:25 +0000
changeset 214 19846c18071b
parent 208 d176cef27a77
child 230 13e275b51d5a
permissions -rw-r--r--
Initial autoconf support.
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
------------------------------------------------------------------------------
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     2
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     3
NOTE: THESE INSTRUCTIONS NEED TO BE UPDATED FOR THE NEW BUILD SYSTEM. THIS
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     4
 AFFECTS UNIX, WIN32 AND MACOS!
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     5
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     6
Please bitch to Ryan (icculus@clutteredmind.org) until he updates this.
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
------------------------------------------------------------------------------
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     9
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
    10
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
    11
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    12
Building is (ahem) very easy.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    13
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    14
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    15
ALL PLATFORMS:
91
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    16
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    17
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
    18
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
    19
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    20
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
    21
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
    22
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    23
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    24
UNIX:
91
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    25
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    26
Edit "Makefile", and follow the instructions. The defaults are probably okay
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    27
for general purposes, but give it a once over to make sure. If you don't have
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    28
zLib on your system, you'll need to disable ZIP support.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    29
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    30
run "make"
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    31
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    32
That's it. The library will be sitting in a new directory called "bin".
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    33
60
e5aade8e1b3f Added appropriate make install target.
Ryan C. Gordon <icculus@icculus.org>
parents: 54
diff changeset
    34
Run "make install" to install the library for use on your system.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    35
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    36
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    37
WIN32:
89
2f9f1d02aaca Updated win32 build instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 71
diff changeset
    38
Download http://icculus.org/physfs/downloads/physfs-win32-support.zip, and
205
6808b87ea234 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 187
diff changeset
    39
unpack in the root of the source directory, preserving directory names. If
6808b87ea234 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 187
diff changeset
    40
you did it correctly, there should be a directory named "zlib114" in the
6808b87ea234 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 187
diff changeset
    41
same directory as "physfs.h". This archive has Visual C project files and
89
2f9f1d02aaca Updated win32 build instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 71
diff changeset
    42
the code needed for zipfile support in PhysicsFS, since most Windows boxes
2f9f1d02aaca Updated win32 build instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 71
diff changeset
    43
don't have zlib preinstalled.
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/
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    48
Be sure to install _at least_ the Core SDK and the WMI SDK. I'm not sure if
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    49
this is needed (or usable for Cygwin). Even though you need these SDK updates,
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    50
the compiled PhysicsFS DLL should work on any win32 platform from Win95 and
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    51
WinNT 4.0 and later.
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    52
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    53
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
    54
may not work. Patches are welcome.
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    55
205
6808b87ea234 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 187
diff changeset
    56
After that, if building with CygWin, follow the Unix instructions, above.
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    57
(Which used to work, see caveat about Platform SDK above). If you're using
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    58
Visual C, point the IDE at physfs.dsp, and build. If you're using any other
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    59
compiler, send me a patch when you get it working.  :)
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    60
91
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    61
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
    62
from you; send an email to icculus@clutteredmind.org.
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
    63
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    64
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    65
MACOS 8/9:
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    66
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
    67
unpack it in the root of the physfs folder. It should produce a folder 
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    68
called "Mac Classic Support" that has CodeWarrior 6 project files and a 
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    69
copy of zlib for zipfile support.
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    70
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    71
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
    72
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
    73
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    74
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    75
OTHER PLATFORMS:
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
    76
Many platforms might "just work" with the Unix Makefile (such as BeOS and 
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    77
MacOS X), but have not been heavily tested, if tested at all. To implement a
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    78
new platform or archiver, please read the heavily-commented physfs_internal.h
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
    79
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
    80
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    81
--ryan. (icculus@clutteredmind.org)
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    82