+This is the M5 simulator.
-This is release m5_1.0_beta1 of the M5 simulator.
+For detailed information about building the simulator and getting
+started please refer to http://www.m5sim.org.
-This file contains brief "getting started" information and release
-notes. For more information, see http://m5.eecs.umich.edu. If you
-have questions, please send mail to m5sim-users@lists.sourceforge.net.
+Specific pages of interest are:
+http://www.m5sim.org/wiki/index.php/Compiling_M5
+http://www.m5sim.org/wiki/index.php/Running_M5
+
+Short version:
+
+1. If you don't have SCons version 0.98.1 or newer, get it from
+http://wwww.scons.org.
+
+2. If you don't have SWIG version 1.3.31 or newer, get it from
+http://wwww.swig.org.
+
+3. Make sure you also have gcc version 3.4.6 or newer, Python 2.4 or newer
+(the dev version with header files), zlib, and the m4 preprocessor.
+
+4. In this directory, type 'scons build/ALPHA_SE/tests/debug/quick'. This
+will build the debug version of the m5 binary (m5.debug) for the Alpha
+syscall emulation target, and run the quick regression tests on it.
+
+If you have questions, please send mail to m5-users@m5sim.org
WHAT'S INCLUDED (AND NOT)
-------------------------
-Since you're reading this file, presumably you've managed to untar the
-distribution. The archive you've unpacked has three subdirectories:
- - m5: the simulator itself
- - m5-test: regression tests and scripts to run them
- - ext: less-common external packages needed to build m5
- (currently just "ply")
-
-Although M5 is capable of full-system simulation, the only OS it
-currently supports is the proprietary Compaq/HP Tru64 version of Unix.
-We are thus unable to distribute bootable disk images freely. If you
-have a Tru64 license and are interested in obtaining disk images,
-contact us at m5-dev@eecs.umich.edu.
-
-GETTING STARTED
----------------
-
-The following steps will build and test the simulator. The variable
-"$top" refers to the top directory where you've unpacked the files,
-i.e., the one containing the m5, m5-test, and ext directories.
-
-cd $top/m5/setup
-./setup ALPHA # set up build/ALPHA directory
-cd $top/m5/build/ALPHA
-make m5.opt # use "-j N" if you've got an MP system
-# wait for build...
-cd $top/m5-test
-./do-tests.pl -B ALPHA # test what you just built
-# wait for tests to run...
-# should end with "finished do-tests successfully!"
-
-If you run into errors regarding m5/arch/alpha/decoder.cc, just
-"touch" that file to update its timestamp. This file is generated
-from a compact ISA description using a program written in Python. If
-you have Python 2.2.2 or later installed on your system, you should be
-able to generate it yourself, but if you don't have Python (or have an
-older version), you may run in to trouble. Since we've shipped a
-working copy of decoder.cc, it's not necessary to have Python to build
-M5 (unless you start modifying the ISA decription). Unfortunately,
-sometimes make gets confused and tries to do so anyway. The "touch"
-should convince make to stop trying.
-
+The basic source release includes these subdirectories:
+ - m5:
+ - configs: simulation configuration scripts
+ - ext: less-common external packages needed to build m5
+ - src: source code of the m5 simulator
+ - system: source for some optional system software for simulated systems
+ - tests: regression tests
+ - util: useful utility programs and files
+
+To run full-system simulations, you will need compiled system firmware
+(console and PALcode for Alpha), kernel binaries and one or more disk images.
+These files for Alpha are collected in a separate archive, m5_system.tar.bz2.
+This file can he downloaded separately.
+
+Depending on the ISA used, M5 may support Linux 2.4/2.6, FreeBSD, and the
+proprietary Compaq/HP Tru64 version of Unix. We are able to distribute Linux
+and FreeBSD bootdisks, but we are unable to distribute bootable disk images of
+Tru64 Unix. If you have a Tru64 license and are interested in
+obtaining disk images, contact us at m5-users@m5sim.org
projects / gem5.git / blobdiff