Update release files.
[gem5.git] / README
1 This is release 2.0_beta of the M5 simulator.
2
3 For detailed information about building the simulator and getting
4 started please refer to http://www.m5sim.org.
5
6 Specific pages of interest are:
7 http://www.m5sim.org/wiki/index.php/Compiling_M5
8 http://www.m5sim.org/wiki/index.php/Running_M5
9
10 Short version:
11
12 1. If you don't have SCons version 0.96.91 or newer, get it from
13 http://wwww.scons.org.
14
15 2. If you don't have SWIG version 0.96.91 or newer, get it from
16 http://wwww.swig.org.
17
18 3. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'. This
19 will build the debug version of the m5 binary (m5.debug) for the Alpha
20 syscall emulation target, and run the quick regression tests on it.
21
22 If you have questions, please send mail to m5sim-users@lists.sourceforge.net.
23
24 WHAT'S INCLUDED (AND NOT)
25 -------------------------
26
27 The 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
34 To run full-system simulations, you will need compiled console,
35 PALcode, and kernel binaries and one or more disk images. These files
36 are collected in a separate archive, m5_system_1.1.tar.bz2. This file
37 can he downloaded separately.
38
39 M5 supports Linux 2.4/2.6, FreeBSD, and the proprietary Compaq/HP
40 Tru64 version of Unix. We are able to distribute Linux and FreeBSD
41 bootdisks, but we are unable to distribute bootable disk images of
42 Tru64 Unix. If you have a Tru64 license and are interested in
43 obtaining disk images, contact us at m5-dev@eecs.umich.edu.