-This is release m5_1.1 of the M5 simulator.
-
-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.
+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)
-------------------------
-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
- - alpha-system: source for Alpha console and PALcode
-
-M5 is a capable, full-system simulator that current supports both Linux
-2.4/2.6 and the proprietary Compaq/HP Tru64 version of Unix. We are able
-to distribute Linux 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.
-
-WHAT'S NEEDED
--------------
-- GCC (version 3.3 or 3.4 recommended)
-- Python 2.3 or newer
-- SCons 0.96.1 (see http://www.scons.org)
-
-WHAT'S RECOMMENDED
-------------------
-- MySQL (for statistics complex statistics storage/retrieval)
-- Python-MysqlDB (for statistics analysis)
-
-GETTING STARTED
----------------
-
-There are two different build targets and three optimizations levels:
-
-Target:
--------
-ALPHA_SE - Syscall emulation simulation
-ALPHA_FS - Full system simulation
-
-Optimization:
--------------
-m5.debug - debug version of the code with tracing and without optimization
-m5.opt - optimized version of code with tracing
-m5.fast - optimized version of the code without tracing and asserts
-
-Different targets are built in different subdirectories of m5/build.
-Binaries with the same target but different optimization levels share
-the same directory. Note that you can build m5 in any directory you
-choose by copying the SConstruct file there and creating symbolic links
-to the 'm5' and 'ext' directories.
-
-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. If you
-have a multiprocessor system, you should give scons a "-j N" argument (like
-make) to run N jobs in parallel.
-
-To build and test the syscall-emulation simulator:
-
- cd $top/m5/build
- scons ALPHA_SE/test/opt/quick
-
-To build and test the full-system simualator:
-
-1. Download the full-system binary package from
- http://m5.eecs.umich.edu/dist/m5_system_1.1.tar.bz2. This package includes
- disk images and kernel, palcode, and console binaries for Linux and FreeBSD.
-2. Edit SYSTEMDIR in $top/m5-test/SysPaths.py to point to your local copy
- of the binaries.
-3. In $top/m5/build, run "scons ALPHA_FS/opt/test/quick".
-
+The basic source release includes these subdirectories:
+ - 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