README revision 2815:a83a50a3675b 
1This is release 2.0 of the M5 simulator.
2
3For information about building the simulator and getting started please refer
4to: http://m5.eecs.umich.edu/
5
6Specific Pages of Interest are:
7http://m5.eecs.umich.edu/wiki/index.php/Compiling_M5
8http://m5.eecs.umich.edu/wiki/index.php/Running_M5
9
10If you have questions, please send mail to m5sim-users@lists.sourceforge.net.
11
12WHAT'S INCLUDED (AND NOT)
13-------------------------
14
15The basic source release includes these subdirectories:
16 - m5: 
17   - src: source code of the m5 simulator
18   - test: regression tests
19   - ext: less-common external packages needed to build m5
20   - system/alpha: source for Alpha console and PALcode
21
22To run full-system simulations, you will need compiled console,
23PALcode, and kernel binaries and one or more disk images.  These files
24are collected in a separate archive, m5_system_2.0.tar.bz2.  This file
25is included on the CD release, or you can download it separately from
26Sourceforge.
27
28M5 supports Linux 2.4/2.6, FreeBSD, and the proprietary Compaq/HP
29Tru64 version of Unix. We are able to distribute Linux and FreeBSD
30bootdisks, but we are unable to distribute bootable disk images of
31Tru64 Unix. If you have a Tru64 license and are interested in
32obtaining disk images, contact us at m5-dev@eecs.umich.edu.
33
34The CD release includes a few extra goodies, such as a tar file
35containing doxygen-generated HTML documentation (html-docs.tar.gz), a
36set of Linux source patches (linux_m5-2.6.8.1.diff), and the scons
37program needed to build M5.  If you do not have the CD, the same HTML
38documentation is available online at http://m5.eecs.umich.edu/docs,
39the Linux source patches are available at
40http://m5.eecs.umich.edu/dist/linux_m5-2.6.8.1.diff, the scons
41program is available from http://www.scons.org, and swig is available from
42http://www.swig.org.
43
44
45