summaryrefslogtreecommitdiff
path: root/configs/learning_gem5/README
diff options
context:
space:
mode:
authorJason Lowe-Power <power.jg@gmail.com>2015-09-16 09:35:36 -0500
committerJason Lowe-Power <power.jg@gmail.com>2015-09-16 09:35:36 -0500
commitf065f9941b5e3b2796ec46d1926115283edd66cd (patch)
treefd115020de8f10457614eb747c463aa5928ca7e4 /configs/learning_gem5/README
parent0d6a6dfd7b500aff7e91a22c9bb7211e1807b90e (diff)
downloadgem5-f065f9941b5e3b2796ec46d1926115283edd66cd.tar.xz
config: Add configs scripts used in Learning gem5
Added a new directory in configs (learning_gem5) to hold the scripts that are used in the book. See http://lowepower.com/jason/learning_gem5/ for a working copy. For now, only the scripts in Part 1: Getting started with gem5 have been added. A separate patch adds tests for these scripts. Committed by: Nilay Vaish <nilay@cs.wisc.edu>
Diffstat (limited to 'configs/learning_gem5/README')
-rw-r--r--configs/learning_gem5/README29
1 files changed, 29 insertions, 0 deletions
diff --git a/configs/learning_gem5/README b/configs/learning_gem5/README
new file mode 100644
index 000000000..ae7d62aab
--- /dev/null
+++ b/configs/learning_gem5/README
@@ -0,0 +1,29 @@
+
+Learning_gem README
+-------------------
+This directory contains the configuration scripts used in the "Learning gem5"
+book. The scripts contained in these directories are for educational purposes
+only and should not be used for architectural research as-is.
+
+"Learning gem5" is currently in early development stages. A pre-alpha working
+version of the book can be found at the following URL.
+
+http://lowepower.com/jason/learning_gem5/
+
+This directory is broken into one subdirectory per part of the book.
+
+Goals of these scripts
+~~~~~~~~~~~~~~~~~~~~~~
+These scripts are not necessarily useful outside the scope of the learning
+gem5 book. The goal is to include the learning gem5 scripts, following the
+book as closely as possible, so that the regression tester will catch any
+changes that affect the book.
+
+For general users, these are *not* good scripts to use for running complex
+architectural experiments. These scripts *are* a good starting point example
+of how to write your own scripts for experiments.
+
+Feedback
+~~~~~~~~
+Send mail to power.jg@gmail.com to provide feedback.
+