summaryrefslogtreecommitdiff
path: root/freetype/tests/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'freetype/tests/README.md')
-rw-r--r--freetype/tests/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/freetype/tests/README.md b/freetype/tests/README.md
new file mode 100644
index 000000000..0d0b99aa8
--- /dev/null
+++ b/freetype/tests/README.md
@@ -0,0 +1,22 @@
+# Unit and regression tests for the FreeType library
+
+## Quick Start
+
+### Download test fonts
+
+Run the `tests/scripts/download-fonts.py` script, which will
+download test fonts to the `tests/data/` directory first.
+
+### Build the test programs
+
+The tests are only built with the Meson build system, and
+are disabled by default, enable the 'tests' option to compile
+them, as in:
+
+ meson setup out -Dtests=enabled
+ meson compile -C out
+
+### Run the test programs
+
+ meson test -C out
+