-This is the M5 simulator.
+This is the gem5 simulator.
-For detailed information about building the simulator and getting
-started please refer to http://www.m5sim.org.
+The main website can be found at http://www.gem5.org
-Specific pages of interest are:
-http://www.m5sim.org/wiki/index.php/Compiling_M5
-http://www.m5sim.org/wiki/index.php/Running_M5
+A good starting point is http://www.gem5.org/about, and for
+more information about building the simulator and getting started
+please see http://www.gem5.org/documentation and
+http://www.gem5.org/documentation/learning_gem5/introduction.
-Short version:
+To build gem5, you will need the following software: g++ or clang,
+Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4,
+and lastly protobuf if you want trace capture and playback
+support. Please see http://www.gem5.org/documentation/general_docs/building
+for more details concerning the minimum versions of the aforementioned tools.
-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)
--------------------------
+Once you have all dependencies resolved, type 'scons
+build/<ARCH>/gem5.opt' where ARCH is one of ARM, NULL, MIPS, POWER, SPARC,
+or X86. This will build an optimized version of the gem5 binary (gem5.opt)
+for the the specified architecture. See
+http://www.gem5.org/documentation/general_docs/building for more details and
+options.
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
+ - 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.
-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
+(console and PALcode for Alpha), kernel binaries and one or more disk
+images.
+
+If you have questions, please send mail to gem5-users@gem5.org
+
+Enjoy using gem5 and please share your modifications and extensions.
projects / gem5.git / blobdiff