From eeda3dd77095e31e1383861dfe830a4af34f8b37 Mon Sep 17 00:00:00 2001
From: Howard Mao <zhehao.mao@gmail.com>
Date: Wed, 11 Nov 2015 18:30:19 -0800
Subject: [PATCH] add README

---
 groundtest/README | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 groundtest/README

diff --git a/groundtest/README b/groundtest/README
new file mode 100644
index 00000000..3d594db7
--- /dev/null
+++ b/groundtest/README
@@ -0,0 +1,11 @@
+# groundtest
+
+A memory tester circuit for Rocket Chip's memory system. The generator tile
+plugs into the existing SoC generator as what looks like a CPU. However,
+instead of running programs, the tile generates fixed memory requests out to
+the L2. There are both cached and uncached generators. The cached generator
+has an intervening L1 cache, the uncached generator sends TileLink requests
+directly to the L2.
+
+Assertions are set to fail if the wrong data comes back or if a request times
+out waiting for the response.