X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=README;h=0f61a0416ed114ddf78e0f5f14b5609680d16a0e;hb=eb7c923e10cfb60f216d7452d94b0fd0b237c38f;hp=fe5b99f238c53860c0984821d509400b93cd3bd7;hpb=8f19fd2cbef2680a186bc101437b69514ad0bc1c;p=gem5.git

diff --git a/README b/README
index fe5b99f23..0f61a0416 100644
--- a/README
+++ b/README
@@ -1,59 +1,43 @@
-This is release m5_1.0_beta1 of the M5 simulator.
+This is release 2.0_beta (patch 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.
+For detailed information about building the simulator and getting
+started please refer to http://www.m5sim.org.
+
+Specific pages of interest are:
+http://www.m5sim.org/wiki/index.php/Compiling_M5
+http://www.m5sim.org/wiki/index.php/Running_M5
+
+Short version:
+
+1. If you don't have SCons version 0.96.91 or newer, get it from
+http://wwww.scons.org.
+
+2. If you don't have SWIG version 1.3.28 or newer, get it from
+http://wwww.swig.org.
+
+3. 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)
 -------------------------
 
-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
-   (currently ply and libelf)
-
-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(3.X)
--Python(2.2.2+)
-
-WHAT'S RECOMMENDED
-------------------
--MySQL (for statistics complex statistics storage/retrieval)
--Python-MysqlDB (for statistics analysis) 
-
-GETTING STARTED
----------------
-
-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.
-
-There are three different build targets and three optimizations in each level:
-Target:
--------
-ALPHA  - Syscall emulation simulation
-KERNEL - Linux full system simulation
-KERNEL_TLASER - Tru64 Unix 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
-
-cd $top/m5/build
-scons TARGET/OPTLEVL  # e.g. KERNEL/m5.opt, use -j N if you have a MP system
-cd $top/m5-test
-./do-tests.pl -B ALPHA	# test what you just built
-./do-tests.pl -B KERNEL	# test what you just built
-# wait for tests to run...
-# should end with "finished do-tests successfully!"
+The basic source release includes these subdirectories:
+ - m5: 
+   - src: source code of the m5 simulator
+   - tests: 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.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
+Tru64 Unix. If you have a Tru64 license and are interested in
+obtaining disk images, contact us at m5-dev@eecs.umich.edu.