README

   1 This is release 2.0 of the M5 simulator.
   2
   3 For information about building the simulator and getting started please refer
   4 to: http://m5.eecs.umich.edu/
   5
   6 Specific Pages of Interest are:
   7 http://m5.eecs.umich.edu/wiki/index.php/Compiling_M5
   8 http://m5.eecs.umich.edu/wiki/index.php/Running_M5
   9
  10 If you have questions, please send mail to m5sim-users@lists.sourceforge.net.
  11
  12 WHAT'S INCLUDED (AND NOT)
  13 -------------------------
  14
  15 The basic source release includes these subdirectories:
  16  - m5:
  17    - src: source code of the m5 simulator
  18    - test: regression tests
  19    - ext: less-common external packages needed to build m5
  20    - system/alpha: source for Alpha console and PALcode
  21
  22 To run full-system simulations, you will need compiled console,
  23 PALcode, and kernel binaries and one or more disk images.  These files
  24 are collected in a separate archive, m5_system_2.0.tar.bz2.  This file
  25 is included on the CD release, or you can download it separately from
  26 Sourceforge.
  27
  28 M5 supports Linux 2.4/2.6, FreeBSD, and the proprietary Compaq/HP
  29 Tru64 version of Unix. We are able to distribute Linux and FreeBSD
  30 bootdisks, but we are unable to distribute bootable disk images of
  31 Tru64 Unix. If you have a Tru64 license and are interested in
  32 obtaining disk images, contact us at m5-dev@eecs.umich.edu.
  33
  34 The CD release includes a few extra goodies, such as a tar file
  35 containing doxygen-generated HTML documentation (html-docs.tar.gz), a
  36 set of Linux source patches (linux_m5-2.6.8.1.diff), and the scons
  37 program needed to build M5.  If you do not have the CD, the same HTML
  38 documentation is available online at http://m5.eecs.umich.edu/docs,
  39 the Linux source patches are available at
  40 http://m5.eecs.umich.edu/dist/linux_m5-2.6.8.1.diff, the scons
  41 program is available from http://www.scons.org, and swig is available from
  42 http://www.swig.org.
  43
  44