resources: Add README.md to GCN3 Square resource
Change-Id: Ia480cf48fad66876f4ccdb39d9cc6f22c918704e
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5-resources/+/41259
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: Bobby R. Bruce <bbruce@ucdavis.edu>
diff --git a/src/square/README.md b/src/square/README.md
new file mode 100644
index 0000000..1923b20
--- /dev/null
+++ b/src/square/README.md
@@ -0,0 +1,33 @@
+# GCN3 Square Test
+
+The square test is used to test the GCN3-GPU model.
+
+Compiling square, compiling the GCN3_X86 gem5, and runing square on gem5is dependent on the gcn-gpu docker image, built from the `util/dockerfiles/gcn-gpu/Dockerfile` on the [gem5 stable branch](https://gem5.googlesource.com/public/gem5/+/refs/heads/stable).
+
+## Compiling Square
+
+```
+cd src/square
+docker run --rm -v ${PWD}:${PWD} -w ${PWD} -u $UID:$GID gcr.io/gem5-test/gcn-gpu make gfx8-apu
+```
+
+The compiled binary can be found in the `bin` directory.
+
+A pre-built binary can be found at <http://dist.gem5.org/dist/v20-1/test-progs/square/square.o>.
+
+
+## Compiling GN3_X86/gem5.opt
+
+The test is run with the GCN3_X86 gem5 variant, compiled using the gcn-gpu docker image:
+
+```
+git clone https://gem5.googlesource.com/public/gem5
+cd gem5
+docker run -u $UID:$GUID --volume $(pwd):$(pwd) -w $(pwd) gcr.io/gem5-test/gcn-gpu:latest scons build/GCN3_X86/gem5.opt -j <num cores>
+```
+
+## Running Square on GCN3_X86/gem5.opt
+
+```
+docker run -u $UID:$GUID --volume $(pwd):$(pwd) -w $(pwd) gcr.io/gem5-test/gcn-gpu:latest gem5/build/GCN3_X86/gem5.opt gem5/configs/example/apu_se.py -n <num cores> -c bin/square.o
+```
