From d8a70c4f714f58becf9750328d1e465db0fdb6a3 Mon Sep 17 00:00:00 2001
From: Ben Vanik <ben.vanik@gmail.com>
Date: Thu, 31 Dec 2015 12:25:32 -0800
Subject: [PATCH] Instructions and repo config.

---
 .gitattributes |  2 ++
 .gitignore     |  1 +
 README.md      | 34 ++++++++++++++++++++++++++++++++++
 3 files changed, 37 insertions(+)
 create mode 100644 .gitattributes
 create mode 100644 .gitignore

diff --git a/.gitattributes b/.gitattributes
new file mode 100644
index 0000000..4ed5a42
--- /dev/null
+++ b/.gitattributes
@@ -0,0 +1,2 @@
+*.png filter=lfs diff=lfs merge=lfs -text
+*.xenia_gpu_trace filter=lfs diff=lfs merge=lfs -text
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..085e8ba
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+Thumbs.db
diff --git a/README.md b/README.md
index 4d29989..8cecb0b 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,37 @@
 # reference-gpu-traces
 
 Captured GPU traces and reference imagery for automated regression testing.
+
+## Running Tests
+
+To run tests check out the main xenia repo, ensure you have
+[Git LFS](https://git-lfs.github.com/) installed, and run:
+
+```
+  $ xb gputest
+```
+
+You can find a results file at `build/gputest/results.html` containing diffs.
+
+## Adding Traces
+
+Pass `--trace_gpu_prefix=testdata/reference-gpu-traces/traces/` to xenia to
+have captured traces be automatically placed in the right folder, or copy your
+new trace files to `traces/` and `git add`.
+
+Run the reference update only for your new files:
+
+```
+  $ xb gputest --generate_missing_reference_files
+```
+
+Commit the new traces and reference files.
+
+## Updating Golden Reference Imagery
+
+```
+  $ xb gputest --update_reference_files
+```
+
+Commit any diffs (ensuring LFS is setup) and then bump the main xenia submodule
+revision.