]> Pileus Git - ~andy/gtk/commitdiff
Add a README for accessibility-dump
authorMatthias Clasen <mclasen@redhat.com>
Tue, 21 Jun 2011 23:34:55 +0000 (19:34 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 5 Jul 2011 20:08:03 +0000 (16:08 -0400)
tests/a11y/README [new file with mode: 0644]

diff --git a/tests/a11y/README b/tests/a11y/README
new file mode 100644 (file)
index 0000000..434b0d7
--- /dev/null
@@ -0,0 +1,18 @@
+accessibility-dump is a test runner that can do tests of static
+accessibility information. Run it like this:
+
+./accessibility-dump [OPTIONS] TESTFILE [TESTFILES...]
+
+where TESTFILE is a GtkBuilder .ui file. accessibility-dump creates
+a textual dump of the accessibility information for the created
+widget hierarchy and compares it to a preexisting .txt file.
+
+To create an initial dump, you can use the --generate option with
+a single .ui file. You should carefully inspect the output before
+blessing it as the official .txt to compare against.
+
+To find out details about a failure, you can use the --verbose
+option to see differences between expected and actual output.
+
+When run without any arguments, all the .ui files in the current
+directory are tested.