ARM: Squash state on FPSCR stride or len write.
[gem5.git] / README
diff --git a/README b/README
index 5f3ea3653e6cd45d3a17998ff070191dfda0568d..3b6a3f6bd9b8890d6b2afaf29d7e0cf4dafc3025 100644 (file)
--- a/README
+++ b/README
@@ -1,31 +1,48 @@
-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://www.m5sim.org/
+For detailed information about building the simulator and getting
+started please refer to http://www.m5sim.org.
 
-Specific Pages of Interest are:
+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:
+
+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)
 -------------------------
 
 The basic source release includes these subdirectories:
- - m5: 
+ - 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
-   - ext: less-common external packages needed to build m5
-   - system/alpha: source for Alpha console and PALcode
+   - util: useful utility programs and files
 
-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
-can he downloaded separately from Sourceforge.
+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.
 
-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
+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-dev@eecs.umich.edu.
+obtaining disk images, contact us at m5-users@m5sim.org