summaryrefslogtreecommitdiff
path: root/boilerplate/README
diff options
context:
space:
mode:
Diffstat (limited to 'boilerplate/README')
-rw-r--r--boilerplate/README14
1 files changed, 14 insertions, 0 deletions
diff --git a/boilerplate/README b/boilerplate/README
new file mode 100644
index 000000000..2a27c415c
--- /dev/null
+++ b/boilerplate/README
@@ -0,0 +1,14 @@
+This directory provides code that is common to both of cairo's tests
+suites:
+
+ * The test suite for correctness in test/
+ * The test suite for performance in perf/
+
+We call it boilerplate as it consists primarily of the boilerplate
+code necessary for initializing a backend in order to create a surface
+for that backend.
+
+The code here just might be useful for someone looking to get started
+writing cairo code to use a particular backend, (but there are no
+promises that the boilerplate code found here for any particular
+backend is exemplary).