README revision 7974:13692327bb0b 
1This is the M5 simulator.
2
3For detailed information about building the simulator and getting
4started please refer to http://www.m5sim.org.
5
6Specific pages of interest are:
7http://www.m5sim.org/wiki/index.php/Compiling_M5
8http://www.m5sim.org/wiki/index.php/Running_M5
9
10Short version:
11
121. If you don't have SCons version 0.98.1 or newer, get it from
13http://wwww.scons.org.
14
152. If you don't have SWIG version 1.3.31 or newer, get it from
16http://wwww.swig.org.
17
183. Make sure you also have gcc version 3.4.6 or newer, Python 2.4 or newer
19(the dev version with header files), zlib, and the m4 preprocessor.
20
214. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'.  This
22will build the debug version of the m5 binary (m5.debug) for the Alpha
23syscall emulation target, and run the quick regression tests on it.
24
25If you have questions, please send mail to m5-users@m5sim.org
26
27WHAT'S INCLUDED (AND NOT)
28-------------------------
29
30The basic source release includes these subdirectories:
31 - m5:
32   - configs: simulation configuration scripts
33   - ext: less-common external packages needed to build m5
34   - src: source code of the m5 simulator
35   - system: source for some optional system software for simulated systems
36   - tests: regression tests
37   - util: useful utility programs and files
38
39To run full-system simulations, you will need compiled system firmware
40(console and PALcode for Alpha), kernel binaries and one or more disk images. 
41These files for Alpha are collected in a separate archive, m5_system.tar.bz2.
42This file can he downloaded separately.
43
44Depending on the ISA used, M5 may support Linux 2.4/2.6, FreeBSD, and the
45proprietary Compaq/HP Tru64 version of Unix. We are able to distribute Linux
46and FreeBSD bootdisks, but we are unable to distribute bootable disk images of
47Tru64 Unix. If you have a Tru64 license and are interested in
48obtaining disk images, contact us at m5-users@m5sim.org
49