README revision 2989:9a6f66c38acc 
1This is release 2.0_beta of 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.96.91 or newer, get it from
13http://wwww.scons.org.
14
152. If you don't have SWIG version 1.3.28 or newer, get it from
16http://wwww.swig.org.
17
183. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'.  This
19will build the debug version of the m5 binary (m5.debug) for the Alpha
20syscall emulation target, and run the quick regression tests on it.
21
22If you have questions, please send mail to m5sim-users@lists.sourceforge.net.
23
24WHAT'S INCLUDED (AND NOT)
25-------------------------
26
27The basic source release includes these subdirectories:
28 - m5: 
29   - src: source code of the m5 simulator
30   - tests: regression tests
31   - ext: less-common external packages needed to build m5
32   - system/alpha: source for Alpha console and PALcode
33
34To run full-system simulations, you will need compiled console,
35PALcode, and kernel binaries and one or more disk images.  These files
36are collected in a separate archive, m5_system_1.1.tar.bz2.  This file
37can he downloaded separately.
38
39M5 supports Linux 2.4/2.6, FreeBSD, and the proprietary Compaq/HP
40Tru64 version of Unix. We are able to distribute Linux and FreeBSD
41bootdisks, but we are unable to distribute bootable disk images of
42Tru64 Unix. If you have a Tru64 license and are interested in
43obtaining disk images, contact us at m5-dev@eecs.umich.edu.
44