New file.

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..542b9e1
--- /dev/null
+++ b/README
@@ -0,0 +1,11 @@
+$Id$
+
+mdfrm is a simple mail reporting program inspired by elm's frm
+program.  Whereas elm's frm operates on Berkeley mbox files, mdfrm
+operates on maildirs.  It prints one line for each message in
+Maildir/new, first the From header and then the Subject header.
+
+mdfrm makes use of fgetln(3), which as far as i can tell is only
+available on BSD.  To make this easy to use on other UNIX-like
+platforms, i have copied Marc Espie's portable implementation from
+OpenBSD make(1).  See fgetln.c for details.