summaryrefslogtreecommitdiff
path: root/misc/fontsample/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'misc/fontsample/README.md')
-rw-r--r--misc/fontsample/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/misc/fontsample/README.md b/misc/fontsample/README.md
new file mode 100644
index 000000000..357b93e6f
--- /dev/null
+++ b/misc/fontsample/README.md
@@ -0,0 +1,21 @@
+# fontsample
+
+A macOS-specific program for generating a PDF with text sample of a
+specific font file.
+
+```
+$ make
+$ ./fontsample -h
+usage: ./fontsample [options] <fontfile>
+
+options:
+ -h, -help Show usage and exit.
+ -z, -size <size> Font size to render. Defaults to 96.
+ -t, -text <text> Text line to render. Defaults to "Rags78 **A**".
+ -o <file> Write output to <file> instead of default filename.
+ Defaults to <fontfile>.pdf. If the provided filename
+ ends with ".png" a PNG is written instead of a PDF.
+
+<fontfile>
+ Any font file that macOS can read.
+```