11) Compilation requirements
2---------------------------
3
4For compiling ARAnyM you will need libSDL, version at least 1.2.10.
5You can get it from http://www.libsdl.org/ or from your OS distribution vendor.
6
7If you want to compile source fetched from Git you also need
8automake, libtool and autoconf (http://www.gnu.org/ or your OS vendor).
9
10Supported platforms:
11
12All Debian GNU/Linux platforms
13
14and
15
16x86          BeOS
17x86          GNU/Linux
18x86          MS Windows + Cygwin
19x86          OpenBSD (unmaintained)
20PPC          MacOS X
21SGI          Irix (unmaintained)
22Sun Sparc    Solaris
23
24In progress (in alphabetical order):
25m68k         FreeMiNT
26x86          FreeBSD
27x86          NetBSD
28
29
302) Compilation
31--------------
32
33  2-1) Unix or Linux
34  ------------------
35If you got the source code from Git then type
36./autogen.sh && make
37
38If you have a source snapshot or proper ARAnyM source code release then type
39./configure && make
40
41./configure --help shows you all the compile time options.
42
43If everything went OK you got an executable file named "aranym".
44
45
46  2-2) Microsoft Windows
47  ----------------------
48Compilation is accomplished using the Cygwin linux-like environment
49(http://www.cygwin.com/).
50
51Details are available in tools/build-cygwin.txt.
52
53
54  2-3) Apple Mac OS X
55  -------------------
56Go to src/Unix/darwin folder first.
57
58If you got the source code from Git then just type
59make
60
61If you want to configure ARAnyM for your personal needs, type
62../configure_ppc --help
63
64Add preferred options to the CONFIGURE_OPTIONS_ppc and CONFIGURE_OPTIONS_i386
65variables at the top of Makefile inside the darwin folder. After that run make
66again.
67
68If everything went OK, you got an executable named "ARAnyM.app" inside the
69src/Unix/darwin folder.
70
71This application expects its default configuration inside the current user's
72~/Library/Preferences/org.aranym.amcfg file. Inside that config file a path
73beginning with */ will be expanded to ~/Library/Application Support/ARAnyM.
74
75The ARAnyM.app also supports virtual machine bundles: Put all your disk image
76files, host-fs destination folders, ROM image etc. and a properly configured
77org.aranym.amcfg file into a new folder. Give that folder the extension
78".ARAnyM" or ".amvm". The Mac OS X Finder will then treat this new Folder as a
79so called bundle. Just dubble click on it and ARAnyM should start and use it.
80
81To modify such a bundles content, in the Finder Control-click or right-click on
82it and select "Show Package Contents".
83
84There are also other methods of building ARAnyM for OS X. Refere also to the
85documents inside src/Unix/MacOSX.
86
87  2-4) FreeBSD (i386)
88  -------------------
89If you got the source code from Git then type
90MAKE=gmake
91./autogen.sh && gmake
92
93If you have a source snapshot or proper ARAnyM source code release then type
94./configure && make
95
96./configure --help shows you all the compile time options.
97
98If everything went OK you got an executable file named "aranym".
99
1003) Installation
101---------------
102You may install ARAnyM on Unix/Linux by typing 'make install' (have root
103privileges as default configuration installs to /usr/local/),
104or you may run the binary directly by typing ./aranym.
105
106Next step is to obtain the operating system (TOS 4.04 or EmuTOS) and install
107a harddrive. More on this in the README file. Easiest is to download
108one of the 'afros' disk images (Aranym FRee OS) that contain everything
109preinstalled.
110
111
1124) Troubleshooting
113------------------
114
115If you compiled libSDL by yourself and installed to /usr/local/ you might
116experience the following problem when running autogen.sh:
117
118aclocal: configure.in: 835: macro `AM_PATH_SDL' not found in library
119
120The fix is relatively easy:
121
122export ACLOCAL_FLAGS="-I /usr/local/share/aclocal"
123
124This helps aclocal to find the .m4 file and everything is fine then.
125