X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=README;h=126a0d11b9adad899f5bd8c8f160dbf817721626;hb=b72c8798682d307adfe9c1c2a77ac5a6d6240c15;hp=3b6a3f6bd9b8890d6b2afaf29d7e0cf4dafc3025;hpb=63a25a56ccc93c24703fec87f830c833974e7060;p=gem5.git

diff --git a/README b/README
index 3b6a3f6bd..126a0d11b 100644
--- a/README
+++ b/README
@@ -1,48 +1,61 @@
-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.
+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.m5sim.org/wiki/index.php/Compiling_M5
-http://www.m5sim.org/wiki/index.php/Running_M5
+http://www.gem5.org/Introduction
+http://www.gem5.org/Build_System
+http://www.gem5.org/Dependencies
+http://www.gem5.org/Running_gem5
 
 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
+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:
-   - configs: simulation configuration scripts
-   - ext: less-common external packages needed to build m5
-   - src: source code of the m5 simulator
+ - 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. 
-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
+Please see the gem5 download page for these items at http://www.gem5.org/Download