From e5d13dc18fb76b71a4ecb1da28f8c02beaf22d2f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?John=20Ankarstr=C3=B6m?= <john@ankarstrom.se>
Date: Tue, 8 Jun 2021 20:20:14 +0200
Subject: Add documentation

---
 README  | 16 ++++++++++++++++
 convert |  4 ++++
 rename  |  2 +-
 3 files changed, 21 insertions(+), 1 deletion(-)
 create mode 100644 README

diff --git a/README b/README
new file mode 100644
index 0000000..d5685e7
--- /dev/null
+++ b/README
@@ -0,0 +1,16 @@
+This folder contains a variety of helpful tools for font conversion.
+
+Makefile:
+
+	.ttf -> .afm -> .dit (ditroff font for (g)troff)
+	.bdf -> .otb
+
+	fonts (install otb fonts to ~/.fonts)
+	groff (install fonts to groff's system font directory)
+
+All rules assume that the fonts are located in the var/ directory.
+
+Extra scripts:
+
+	rename (given a family name, rename troff font file appropriately)
+	convert (batch generate and rename troff font files)
diff --git a/convert b/convert
index 50676c8..186e736 100755
--- a/convert
+++ b/convert
@@ -1,5 +1,9 @@
 #!/bin/sh
 
+# convert -- batch convert .ttf -> .dit
+
+[ $# -eq 0 ] && { echo usage: $0 family ttf ... 1>&2; exit 1; }
+
 f=$1
 shift
 
diff --git a/rename b/rename
index e8a87e0..cece8c9 100755
--- a/rename
+++ b/rename
@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 
-# rename -- automatically rename ditroff file
+# rename -- figure out troff font name
 
 sub usage {
 	die "usage: $0 [-n] family file\n";
-- 
cgit v1.2.3