X-Git-Url: https://git.libre-soc.org/?p=gem5.git;a=blobdiff_plain;f=README;h=e24e7a30e64b0f1bc671936b40068ceead6498b0;hp=7bcbe9523953a24dff1c2e508daee7d959000c4e;hb=refs%2Fheads%2Fdevelop-power;hpb=c33b5b3fc469e8f4885254122e60d781dcb11687

diff --git a/README b/README
index 7bcbe9523..e24e7a30e 100644
--- a/README
+++ b/README
@@ -1,44 +1,37 @@
-This is release 2.0 of the M5 simulator.
+This is the gem5 simulator.
 
-For information about building the simulator and getting started please refer
-to: http://m5.eecs.umich.edu/
+The main website can be found at http://www.gem5.org
 
-Specific Pages of Interest are:
-http://m5.eecs.umich.edu/wiki/index.php/Compiling_M5
-http://m5.eecs.umich.edu/wiki/index.php/Running_M5
+A good starting point is http://www.gem5.org/about, and for
+more information about building the simulator and getting started
+please see http://www.gem5.org/documentation and
+http://www.gem5.org/documentation/learning_gem5/introduction.
 
-If you have questions, please send mail to m5sim-users@lists.sourceforge.net.
+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/documentation/general_docs/building
+for more details concerning the minimum versions of the aforementioned tools.
 
-WHAT'S INCLUDED (AND NOT)
--------------------------
+Once you have all dependencies resolved, type 'scons
+build/<ARCH>/gem5.opt' where ARCH is one of 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/documentation/general_docs/building for more details and
+options.
 
 The basic source release includes these subdirectories:
- - m5: 
-   - src: source code of the m5 simulator
-   - test: 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_2.0.tar.bz2.  This file
-is included on the CD release, or you can download it separately from
-Sourceforge.
-
-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.
-
-The CD release includes a few extra goodies, such as a tar file
-containing doxygen-generated HTML documentation (html-docs.tar.gz), a
-set of Linux source patches (linux_m5-2.6.8.1.diff), and the scons
-program needed to build M5.  If you do not have the CD, the same HTML
-documentation is available online at http://m5.eecs.umich.edu/docs,
-the Linux source patches are available at
-http://m5.eecs.umich.edu/dist/linux_m5-2.6.8.1.diff, the scons
-program is available from http://www.scons.org, and swig is available from
-http://www.swig.org.
+   - 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.
 
+If you have questions, please send mail to gem5-users@gem5.org
+
+Enjoy using gem5 and please share your modifications and extensions.