-This is release 2.0 of the M5 simulator.
+This is the M5 simulator.
-For information about building the simulator and getting started please refer
-to: http://m5.eecs.umich.edu/
+For detailed information about building the simulator and getting
+started please refer to http://www.m5sim.org.
-Specific Pages of Interest are:
-http://m5.eecs.umich.edu/wiki/index.php/Compiling_M5
-http://m5.eecs.umich.edu/wiki/index.php/Running_M5
+Specific pages of interest are:
+http://www.m5sim.org/wiki/index.php/Compiling_M5
+http://www.m5sim.org/wiki/index.php/Running_M5
-If you have questions, please send mail to m5sim-users@lists.sourceforge.net.
+Short version:
-WHAT'S INCLUDED (AND NOT)
--------------------------
+1. If you don't have SCons version 0.98.1 or newer, get it from
+http://wwww.scons.org.
-The basic source release includes these subdirectories:
- - m5:
- - src: source code of the m5 simulator
- - test: regression tests
- - ext: less-common external packages needed to build m5
- - system/alpha: source for Alpha console and PALcode
+2. If you don't have SWIG version 1.3.31 or newer, get it from
+http://wwww.swig.org.
-To run full-system simulations, you will need compiled console,
-PALcode, and kernel binaries and one or more disk images. These files
-are collected in a separate archive, m5_system_2.0.tar.bz2. This file
-is included on the CD release, or you can download it separately from
-Sourceforge.
+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.
-M5 supports 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-dev@eecs.umich.edu.
+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.
-The CD release includes a few extra goodies, such as a tar file
-containing doxygen-generated HTML documentation (html-docs.tar.gz), a
-set of Linux source patches (linux_m5-2.6.8.1.diff), and the scons
-program needed to build M5. If you do not have the CD, the same HTML
-documentation is available online at http://m5.eecs.umich.edu/docs,
-the Linux source patches are available at
-http://m5.eecs.umich.edu/dist/linux_m5-2.6.8.1.diff, the scons
-program is available from http://www.scons.org, and swig is available from
-http://www.swig.org.
+If you have questions, please send mail to m5-users@m5sim.org
+WHAT'S INCLUDED (AND NOT)
+-------------------------
+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