-This is release 2.0 of the M5 simulator.
-
-For information about building the simulator and getting started please refer
-to: http://m5.eecs.umich.edu/
-
-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
-
-If you have questions, please send mail to m5sim-users@lists.sourceforge.net.
+This is the gem5 simulator.
+
+For detailed information about building the simulator and getting
+started please refer to:
+* The main website: http://www.gem5.org
+* Documentation wiki: http://www.gem5.org/Documentation
+* Doxygen generated: http://www.gem5.org/docs
+* Tutorials: http://www.gem5.org/Tutorials
+
+
+Specific pages of interest are:
+http://www.gem5.org/Introduction
+http://www.gem5.org/Build_System
+http://www.gem5.org/Dependencies
+http://www.gem5.org/Running_gem5
+
+Short version:
+External tools and required versions
+
+To build gem5, you will need the following software:
+g++ version 4.3 or newer.
+Python, version 2.4 - 2.7 (we don't support Python 3.X). gem5 links in the
+ Python interpreter, so you need the Python header files and shared
+ library (e.g., /usr/lib/libpython2.4.so) in addition to the interpreter
+ executable. These may or may not be installed by default. For example,
+ on Debian/Ubuntu, you need the "python-dev" package in addition to the
+ "python" package. If you need a newer or different Python installation
+ but can't or don't want to upgrade the default Python on your system,
+ see http://www.gem5.org/Using_a_non-default_Python_installation
+SCons, version 0.98.1 or newer. SCons is a powerful replacement for make.
+ If you don't have administrator privileges on your machine, you can use the
+ "scons-local" package to install scons in your m5 directory, or install SCons
+ in your home directory using the '--prefix=' option.
+SWIG, version 1.3.34 or newer
+zlib, any recent version. For Debian/Ubuntu, you will need the "zlib-dev" or
+ "zlib1g-dev" package to get the zlib.h header file as well as the library
+ itself.
+m4, the macro processor.
+
+
+4. In this directory, type 'scons build/<ARCH>/gem5.opt' where ARCH is one
+of ALPHA, ARM, MIPS, POWER, SPARC, or X86. This will build an optimized version
+of the gem5 binary (gem5.opt) for the the specified architecture.
+
+If you have questions, please send mail to gem5-users@gem5.org
WHAT'S INCLUDED (AND NOT)
-------------------------
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
-
-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.
-
-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.
-
-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.
-
-
+ - gem5:
+ - configs: example simulation configuration scripts
+ - ext: less-common external packages needed to build gem5
+ - src: source code of the gem5 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.
+Please see the gem5 download page for these items at http://www.gem5.org/Download
projects / gem5.git / blobdiff