README: Add quick_dump info

Reviewed-by: Paul Menzel <paulepanter@users.sourceforge.net>
Signed-off-by: Ben Widawsky <ben@bwidawsk.net>

1 files changed, 15 insertions, 0 deletions

diff --git a/README b/README
index 0ec53fbc..85075e71 100644
--- a/README
+++ b/README
@@ -75,6 +75,21 @@ tools/
 	These tools generally must be run as root, safe for the ones that just
 	decode dumps.
 
+tools/quick_dump
+	Quick dumper is a python tool built with SWIG bindings to
+	important libraries exported by the rest of the tool suite. The tool
+	itself is quite straight forward, and should also be a useful example
+	for others wishing to write python based i915 tools.
+
+	As of writing, the build is sort of broken in Arch
+	[https://www.archlinux.org/] because of the way they package Python. You'll
+	need something like: ./autogen.sh PYTHON_LDFLAGS="-lpython3.3m"
+
+	Note to package maintainers: It is not recommended to package
+	this directory, as the tool is not yet designed for wide usage. If the
+	package is installed via "make install" the users will have to set
+	their python library path appropriately.
+
 debugger/
 	This tool is to be used to do shader debugging. It acts like a
 	debug server accepting connections from debug clients such as