1Avoid The Roid Installation 2=========================== 3 4Quick and dirty 5Just type ./autogen.sh;./configure;make;make install then run atr3d 6 7OpenAL is required for sound and can be obtained at www.openal.org. 8If you wish to compile without sound, type ./configure --disable-sound. 9To build on cygwin type ./configure --enable-cygwin. 10 11 12Basic Installation 13================== 14 15 These are generic installation instructions. 16 17 The `configure' shell script attempts to guess correct values for 18various system-dependent variables used during compilation. It uses 19those values to create a `Makefile' in each directory of the package. 20It may also create one or more `.h' files containing system-dependent 21definitions. Finally, it creates a shell script `config.status' that 22you can run in the future to recreate the current configuration, a file 23`config.cache' that saves the results of its tests to speed up 24reconfiguring, and a file `config.log' containing compiler output 25(useful mainly for debugging `configure'). 26 27 If you need to do unusual things to compile the package, please try 28to figure out how `configure' could check whether to do them, and mail 29diffs or instructions to the address given in the `README' so they can 30be considered for the next release. If at some point `config.cache' 31contains results you don't want to keep, you may remove or edit it. 32 33 The file `configure.in' is used to create `configure' by a program 34called `autoconf'. You only need `configure.in' if you want to change 35it or regenerate `configure' using a newer version of `autoconf'. 36 37The simplest way to compile this package is: 38 39 1. `cd' to the directory containing the package's source code and type 40 `./configure' to configure the package for your system. If you're 41 using `csh' on an old version of System V, you might need to type 42 `sh ./configure' instead to prevent `csh' from trying to execute 43 `configure' itself. 44 45 Running `configure' takes awhile. While running, it prints some 46 messages telling which features it is checking for. 47 48 2. Type `make' to compile the package. 49 50 3. Optionally, type `make check' to run any self-tests that come with 51 the package. 52 53 4. Type `make install' to install the programs and any data files and 54 documentation. 55 56 5. You can remove the program binaries and object files from the 57 source code directory by typing `make clean'. To also remove the 58 files that `configure' created (so you can compile the package for 59 a different kind of computer), type `make distclean'. There is 60 also a `make maintainer-clean' target, but that is intended mainly 61 for the package's developers. If you use it, you may have to get 62 all sorts of other programs in order to regenerate files that came 63 with the distribution. 64 65Compilers and Options 66===================== 67 68 Some systems require unusual options for compilation or linking that 69the `configure' script does not know about. You can give `configure' 70initial values for variables by setting them in the environment. Using 71a Bourne-compatible shell, you can do that on the command line like 72this: 73 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure 74 75Or on systems that have the `env' program, you can do it like this: 76 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure 77 78Compiling For Multiple Architectures 79==================================== 80 81 You can compile the package for more than one kind of computer at the 82same time, by placing the object files for each architecture in their 83own directory. To do this, you must use a version of `make' that 84supports the `VPATH' variable, such as GNU `make'. `cd' to the 85directory where you want the object files and executables to go and run 86the `configure' script. `configure' automatically checks for the 87source code in the directory that `configure' is in and in `..'. 88 89 If you have to use a `make' that does not supports the `VPATH' 90variable, you have to compile the package for one architecture at a time 91in the source code directory. After you have installed the package for 92one architecture, use `make distclean' before reconfiguring for another 93architecture. 94 95Installation Names 96================== 97 98 By default, `make install' will install the package's files in 99`/usr/local/bin', `/usr/local/man', etc. You can specify an 100installation prefix other than `/usr/local' by giving `configure' the 101option `--prefix=PATH'. 102 103 You can specify separate installation prefixes for 104architecture-specific files and architecture-independent files. If you 105give `configure' the option `--exec-prefix=PATH', the package will use 106PATH as the prefix for installing programs and libraries. 107Documentation and other data files will still use the regular prefix. 108 109 In addition, if you use an unusual directory layout you can give 110options like `--bindir=PATH' to specify different values for particular 111kinds of files. Run `configure --help' for a list of the directories 112you can set and what kinds of files go in them. 113 114 If the package supports it, you can cause programs to be installed 115with an extra prefix or suffix on their names by giving `configure' the 116option `--program-prefix=PREFIX' or `--program-suffix=SUFFIX'. 117 118Optional Features 119================= 120 121 Some packages pay attention to `--enable-FEATURE' options to 122`configure', where FEATURE indicates an optional part of the package. 123They may also pay attention to `--with-PACKAGE' options, where PACKAGE 124is something like `gnu-as' or `x' (for the X Window System). The 125`README' should mention any `--enable-' and `--with-' options that the 126package recognizes. 127 128 For packages that use the X Window System, `configure' can usually 129find the X include and library files automatically, but if it doesn't, 130you can use the `configure' options `--x-includes=DIR' and 131`--x-libraries=DIR' to specify their locations. 132 133Specifying the System Type 134========================== 135 136 There may be some features `configure' can not figure out 137automatically, but needs to determine by the type of host the package 138will run on. Usually `configure' can figure that out, but if it prints 139a message saying it can not guess the host type, give it the 140`--host=TYPE' option. TYPE can either be a short name for the system 141type, such as `sun4', or a canonical name with three fields: 142 CPU-COMPANY-SYSTEM 143 144See the file `config.sub' for the possible values of each field. If 145`config.sub' isn't included in this package, then this package doesn't 146need to know the host type. 147 148 If you are building compiler tools for cross-compiling, you can also 149use the `--target=TYPE' option to select the type of system they will 150produce code for and the `--build=TYPE' option to select the type of 151system on which you are compiling the package. 152 153Sharing Defaults 154================ 155 156 If you want to set default values for `configure' scripts to share, 157you can create a site shell script called `config.site' that gives 158default values for variables like `CC', `cache_file', and `prefix'. 159`configure' looks for `PREFIX/share/config.site' if it exists, then 160`PREFIX/etc/config.site' if it exists. Or, you can set the 161`CONFIG_SITE' environment variable to the location of the site script. 162A warning: not all `configure' scripts look for a site script. 163 164Operation Controls 165================== 166 167 `configure' recognizes the following options to control how it 168operates. 169 170`--cache-file=FILE' 171 Use and save the results of the tests in FILE instead of 172 `./config.cache'. Set FILE to `/dev/null' to disable caching, for 173 debugging `configure'. 174 175`--help' 176 Print a summary of the options to `configure', and exit. 177 178`--quiet' 179`--silent' 180`-q' 181 Do not print messages saying which checks are being made. To 182 suppress all normal output, redirect it to `/dev/null' (any error 183 messages will still be shown). 184 185`--srcdir=DIR' 186 Look for the package's source code in directory DIR. Usually 187 `configure' can determine that directory automatically. 188 189`--version' 190 Print the version of Autoconf used to generate the `configure' 191 script, and exit. 192 193`configure' also accepts some other, not widely useful, options. 194