X-Git-Url: https://git.libre-soc.org/?a=blobdiff_plain;f=README;h=5b0452bd3237df2aa2c3be8bdfac52ab7afa2fc7;hb=4a37134f5f739a2cfed6426d296f7755044d2d28;hp=37ebeb403afbd7dc22acfdba01a9aa52b979ffb8;hpb=d9991ff59953389251c6d081c6318ac1e0549954;p=gem5.git

diff --git a/README b/README
index 37ebeb403..5b0452bd3 100644
--- a/README
+++ b/README
@@ -1,59 +1,41 @@
-This is release m5_1.0 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.
-
-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.4+)
-
-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_SE - Syscall emulation simulation
-ALPHA_FS - Linux full system simulation
-ALPHA_FS_TL - Tru64 (Turbolaser) 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. ALPHA_FS/m5.opt, use -j N if you have a MP system
-cd $top/m5-test
-./do-tests.pl -B ALPHA_SE	# test what you just built
-./do-tests.pl -B ALPHA_FS	# test what you just built
-# wait for tests to run...
-# should end with "finished do-tests successfully!"
+This is the gem5 simulator.
+
+The main website can be found at http://www.gem5.org
+
+A good starting point is http://www.gem5.org/Introduction, and for
+more information about building the simulator and getting started
+please see http://www.gem5.org/Documentation and
+http://www.gem5.org/Tutorials.
+
+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/Dependencies for more details
+concerning the minimum versions of the aforementioned tools.
+
+Once you have all dependencies resolved, type 'scons
+build/<ARCH>/gem5.opt' where ARCH is one of ALPHA, 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/Build_System for more details and options.
+
+With the simulator built, have a look at
+http://www.gem5.org/Running_gem5 for more information on how to use
+gem5.
+
+The basic source release includes these subdirectories:
+   - 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
+
+If you have questions, please send mail to gem5-users@gem5.org
+
+Enjoy using gem5 and please share your modifications and extensions.