README

   1 This is the gem5 simulator.
   2
   3 The main website can be found at http://www.gem5.org
   4
   5 A good starting point is http://www.gem5.org/about, and for
   6 more information about building the simulator and getting started
   7 please see http://www.gem5.org/documentation and
   8 http://www.gem5.org/documentation/learning_gem5/introduction.
   9
  10 To build gem5, you will need the following software: g++ or clang,
  11 Python (gem5 links in the Python interpreter), SCons, SWIG, zlib, m4,
  12 and lastly protobuf if you want trace capture and playback
  13 support. Please see http://www.gem5.org/documentation/general_docs/building
  14 for more details concerning the minimum versions of the aforementioned tools.
  15
  16 Once you have all dependencies resolved, type 'scons
  17 build/<ARCH>/gem5.opt' where ARCH is one of ARM, NULL, MIPS, POWER, SPARC,
  18 or X86. This will build an optimized version of the gem5 binary (gem5.opt)
  19 for the the specified architecture. See
  20 http://www.gem5.org/documentation/general_docs/building for more details and
  21 options.
  22
  23 The basic source release includes these subdirectories:
  24    - configs: example simulation configuration scripts
  25    - ext: less-common external packages needed to build gem5
  26    - src: source code of the gem5 simulator
  27    - system: source for some optional system software for simulated systems
  28    - tests: regression tests
  29    - util: useful utility programs and files
  30
  31 To run full-system simulations, you will need compiled system firmware
  32 (console and PALcode for Alpha), kernel binaries and one or more disk
  33 images.
  34
  35 If you have questions, please send mail to gem5-users@gem5.org
  36
  37 Enjoy using gem5 and please share your modifications and extensions.