docs/INSTALL.txt
author Ryan C. Gordon <icculus@icculus.org>
Fri, 12 Jun 2020 03:37:58 -0400
changeset 1692 acdcf93d1f9b
parent 1680 9cf9cdc05779
permissions -rw-r--r--
android: PhysicsFS now has actual Android support. This compiled and worked on Android before, if you didn't care about PHYSFS_getBaseDir() and PHYSFS_getPrefDir() being useful. Now you can pass PHYSFS_init() some necessary Android objects to solve this. Passing NULL to PHYSFS_init is acceptable and will simply report "/" for the base dir and prefdir, under the assumption that the app queried the OS for these directly instead.
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
283
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
     2
The latest PhysicsFS information and releases can be found at:
1392
5b58af83a5bb Changed some URLs from http:// to https://, where supported.
Ryan C. Gordon <icculus@icculus.org>
parents: 1339
diff changeset
     3
  https://icculus.org/physfs/
214
19846c18071b Initial autoconf support.
Ryan C. Gordon <icculus@icculus.org>
parents: 208
diff changeset
     4
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
     5
Building is (ahem) very easy.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
     6
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
     7
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
     8
ALL PLATFORMS:
91
4a13fbf4a88a Updated again.
Ryan C. Gordon <icculus@icculus.org>
parents: 89
diff changeset
     9
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    10
Please read the text file LICENSE.txt in the root of the source tree.
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    11
 The license is extremely liberal, even to closed-source, commercial
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    12
 applications.
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    13
283
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
    14
If you've got Doxygen (http://www.doxygen.org/) installed, you can run it
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
    15
 without any command line arguments in the root of the source tree to generate
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    16
 the API reference (or build the "docs" target from your build system). This
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    17
 is optional. You can browse the API docs online here:
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    18
1392
5b58af83a5bb Changed some URLs from http:// to https://, where supported.
Ryan C. Gordon <icculus@icculus.org>
parents: 1339
diff changeset
    19
    https://icculus.org/physfs/docs/
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    20
283
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
    21
71
105bdb041c03 More win32 updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 60
diff changeset
    22
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    23
BUILD IT WITH YOUR OWN PROGRAM:
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    24
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    25
If you don't care about formal packaging: just add everything in the "src"
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    26
directory to whatever you use to build your program and compile it along with
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    27
everything else, and you're done. It should compile with any reasonable
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    28
ANSI C compiler, should build cleanly even with excessive compiler warnings
1518
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    29
enabled, needs no extra configuration, and allows static linking.
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    30
WinRT and Haiku need C++ compilers for their system APIs, but if you aren't on
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    31
these platforms and don't have a C++ compiler, don't build the .cpp files.
1549
59ee9cc813c8 apple: Start using some Cocoa APIs, clean up a few related things.
Ryan C. Gordon <icculus@icculus.org>
parents: 1518
diff changeset
    32
Likewise: Apple platforms (macOS, iOS, etc) need an Objective-C compiler, but
59ee9cc813c8 apple: Start using some Cocoa APIs, clean up a few related things.
Ryan C. Gordon <icculus@icculus.org>
parents: 1518
diff changeset
    33
if you aren't on these platforms and don't have a Objective-C compiler, don't
59ee9cc813c8 apple: Start using some Cocoa APIs, clean up a few related things.
Ryan C. Gordon <icculus@icculus.org>
parents: 1518
diff changeset
    34
build the .m file. Everything you need is in the .c sources.
1518
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    35
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    36
If this all worked for your specific project, you can stop reading now.
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    37
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    38
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    39
1680
9cf9cdc05779 Minor style fix in docs/INSTALL.txt
Ryan C. Gordon <icculus@icculus.org>
parents: 1549
diff changeset
    40
Unix:
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    41
1392
5b58af83a5bb Changed some URLs from http:// to https://, where supported.
Ryan C. Gordon <icculus@icculus.org>
parents: 1339
diff changeset
    42
You will need CMake (https://www.cmake.org/) 2.4 or later installed.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    43
957
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    44
Make a directory, wherever you like. This will be your build directory.
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    45
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    46
Chdir to your build directory. Run "cmake /where/i/unpacked/physfs" to
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    47
 generate Makefiles. You can then run "ccmake ." and customize the build,
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    48
 but the defaults are probably okay. You can have CMake generate KDevelop
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    49
 or Ninja project files or whatever, if you prefer these.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    50
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    51
Run "make". PhysicsFS will now build.
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    52
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    53
As root, run "make install".
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    54
 If you get sick of the library, run "make uninstall" as root
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    55
 and it will remove all traces of the library from the system paths.
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
    56
957
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    57
Once you are satisfied, you can delete the build directory.
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    58
488
731e85d74cfe Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 283
diff changeset
    59
Primary Unix development is done with GNU/Linux, but PhysicsFS is known to
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    60
 work out of the box with several flavors of Unix. It it doesn't work, patches
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    61
 to get it running can be sent to icculus@icculus.org.
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    62
488
731e85d74cfe Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 283
diff changeset
    63
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    64
Windows:
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    65
957
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
    66
If building with Cygwin, mingw32, MSYS, or something else that uses the GNU
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    67
 toolchain, follow the Unix instructions, above.
230
13e275b51d5a Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 214
diff changeset
    68
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    69
If you want to use Visual Studio, nmake, or the Platform SDK, you will need
1392
5b58af83a5bb Changed some URLs from http:// to https://, where supported.
Ryan C. Gordon <icculus@icculus.org>
parents: 1339
diff changeset
    70
 CMake (https://www.cmake.org/) 2.4 or later installed. Point CMake at the
888
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    71
 CMakeLists.txt file in the root of the source directory and hit the
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    72
 "Configure" button. After telling it what type of compiler you are targeting
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    73
 (Borland, Visual Studio, etc), CMake will process for while and then give you
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    74
 a list of options you can change (what archivers you want to support, etc).
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    75
 If you aren't sure, the defaults are probably fine. Hit the "Configure"
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    76
 button again, then "OK" once configuration has completed with options that
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    77
 match your liking. Now project files for your favorite programming
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    78
 environment will be generated for you in the directory you specified.
526efb0af72f Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 825
diff changeset
    79
 Go there and use them to build PhysicsFS.
89
2f9f1d02aaca Updated win32 build instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 71
diff changeset
    80
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
    81
PhysicsFS will only link directly against system libraries that have existed
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    82
 since Windows NT 3.51. If there's a newer API we want to use, we try to
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    83
 dynamically load it at runtime and fallback to a reasonable behaviour when
1518
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    84
 we can't find it. Note that Windows 98 and later _should_
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    85
 work if you use the Microsoft Layer for Unicode (UNICOWS.DLL) to provide
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
    86
 some missing system APIs, but this is no longer tested as of PhysicsFS 2.1.0.
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    87
 PhysicsFS 2.0.x is known to work with Windows 95 without UNICOWS.DLL.
283
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
    88
1339
2043aa8a2523 Updated installation notes.
Ryan C. Gordon <icculus@icculus.org>
parents: 1216
diff changeset
    89
PhysicsFS works on 32-bit and 64-bit Windows. There is no 16-bit Windows
1518
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    90
 support at all. Windows RT is covered below.
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    91
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    92
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    93
Windows RT:
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
    94
1518
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    95
Windows RT (Windows Phone, Windows Store, UWP) 8.0 and later are supported.
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    96
Make sure you include both physfs_platform_windows.c _and_
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    97
physfs_platform_winrt.cpp in your build, and that the C++ file has
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    98
"Consume Windows Runtime Extension" set to "Yes" in its Visual Studio
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
    99
properties (from the command line, you want to compile this file with the
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
   100
"/ZW" compiler switch). CMake can, in theory, generate a project file for
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
   101
WinRT if you pick a recent Visual Studio target, choose manual cross-compile
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
   102
options, and set the system name to "WindowsPhone" or "WindowsStore" and the
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
   103
correct OS version (8.0 or later).
a6ac19814d53 Serious cleanup and update of Windows RT support.
Ryan C. Gordon <icculus@icculus.org>
parents: 1511
diff changeset
   104
208
d176cef27a77 Updated win32 build info, other tweaks.
Ryan C. Gordon <icculus@icculus.org>
parents: 205
diff changeset
   105
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   106
PocketPC/WindowsCE:
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
   107
1196
54a1dfb1e6f7 Removed PocketPC support. It was old and crusty and targeted a dead platform.
Ryan C. Gordon <icculus@icculus.org>
parents: 972
diff changeset
   108
Support for PocketPC was removed in PhysicsFS 2.1.0. This was known to work
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   109
 in the 1.0 releases, but wasn't tested in 2.0 and later. PhysicsFS should
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   110
 work on modern Windows Phones (see "Windows RT" section).
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
   111
283
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
   112
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   113
macOS:
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   114
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   115
You will need CMake (https://www.cmake.org/) 2.4 or later installed.
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   116
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   117
You can either generate a Unix makefile with CMake, or generate an Xcode
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   118
 project, whichever makes you more comfortable.
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   119
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   120
PowerPC and Intel Macs should both be supported.
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   121
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   122
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   123
MAC OS 8/9 ("Mac OS Classic"):
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   124
825
b26da6cdcebb Dropped classic Mac OS support. Mac OS X remains supported, though.
Ryan C. Gordon <icculus@icculus.org>
parents: 820
diff changeset
   125
Classic Mac OS support has been dropped in PhysicsFS 2.0. Apple hasn't updated
957
039f79f1ad0a Updated install instructions.
Ryan C. Gordon <icculus@icculus.org>
parents: 888
diff changeset
   126
 pre-OSX versions in more than a decade at this point, none of the hardware
825
b26da6cdcebb Dropped classic Mac OS support. Mac OS X remains supported, though.
Ryan C. Gordon <icculus@icculus.org>
parents: 820
diff changeset
   127
 they've shipped will boot it for almost as many years, and finding
b26da6cdcebb Dropped classic Mac OS support. Mac OS X remains supported, though.
Ryan C. Gordon <icculus@icculus.org>
parents: 820
diff changeset
   128
 developer tools for it is becoming almost impossible. As the switch to Intel
b26da6cdcebb Dropped classic Mac OS support. Mac OS X remains supported, though.
Ryan C. Gordon <icculus@icculus.org>
parents: 820
diff changeset
   129
 hardware has removed the "Classic" emulation environment, it was time to
b26da6cdcebb Dropped classic Mac OS support. Mac OS X remains supported, though.
Ryan C. Gordon <icculus@icculus.org>
parents: 820
diff changeset
   130
 remove support from PhysicsFS. That being said, the PhysicsFS 1.0 branch can
b26da6cdcebb Dropped classic Mac OS support. Mac OS X remains supported, though.
Ryan C. Gordon <icculus@icculus.org>
parents: 820
diff changeset
   131
 still target back to Mac OS 8.5, so you can use that if you need support for
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   132
 this legacy OS. We still very much support modern macOS, though: see above.
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   133
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   134
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   135
Emscripten:
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   136
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   137
Use the "Unix" instructions, above. You can install the Emscripten SDK and use
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   138
 the extras/buildbot-emscripten.sh script to automate this for you.
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   139
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   140
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   141
BeOS, Zeta, YellowTab:
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   142
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   143
BeOS support was dropped in PhysicsFS 2.1.0. Consider installing Haiku, which
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   144
we still support.
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   145
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   146
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   147
Haiku:
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   148
1501
36fdea407cbd Some improvements to INSTALL.txt.
Ryan C. Gordon <icculus@icculus.org>
parents: 1444
diff changeset
   149
Use the "Unix" instructions, above.
283
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
   150
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
   151
488
731e85d74cfe Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 283
diff changeset
   152
OS/2:
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   153
1444
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   154
OS/2 is known to work with OpenWatcom and GCC-based compilers. I couldn't get
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   155
an OS/2 port of CMake to generate OpenWatcom project files (although it should
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   156
be able to do that in theory), it should be able to do Unix Makefiles with
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   157
GCC. It might be easier to just compile PhysicsFS along with the rest of
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   158
your project on this platform.
70f8dc26109c Updated INSTALL.txt to more closely reflect reality.
Ryan C. Gordon <icculus@icculus.org>
parents: 1392
diff changeset
   159
488
731e85d74cfe Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 283
diff changeset
   160
283
c966316c8998 Updated.
Ryan C. Gordon <icculus@icculus.org>
parents: 230
diff changeset
   161
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
   162
OTHER PLATFORMS:
812
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   163
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   164
Many Unix-like platforms might "just work" with CMake. Some of these platforms
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   165
 are known to have worked at one time, but have not been heavily tested, if
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   166
 tested at all. PhysicsFS is, as far as we know, 64-bit and byteorder clean,
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   167
 and is known to compile on several compilers across many platforms. To
b987fcf6f707 Updated INSTALL.txt with updated info.
Ryan C. Gordon <icculus@icculus.org>
parents: 811
diff changeset
   168
 implement a new platform or archiver, please read the heavily-commented
1511
a99753a9b80e Minor documentation updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 1501
diff changeset
   169
 physfs_internal.h and look at the physfs_platform_* and physfs_archiver_*
a99753a9b80e Minor documentation updates.
Ryan C. Gordon <icculus@icculus.org>
parents: 1501
diff changeset
   170
 source files for examples.
187
1241722f5f28 Added MacOS info, etc.
Ryan C. Gordon <icculus@icculus.org>
parents: 91
diff changeset
   171
767
db29bf06d171 Changed my email address.
Ryan C. Gordon <icculus@icculus.org>
parents: 680
diff changeset
   172
--ryan. (icculus@icculus.org)
54
2756e7c8125f Initial add.
Ryan C. Gordon <icculus@icculus.org>
parents:
diff changeset
   173