Add plain-text README

1 files changed, 31 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..392d2c8
--- /dev/null
+++ b/README
@@ -0,0 +1,31 @@
+--- Overview ---
+
+This repository can be divided into three parts:
+
+ * mu (top directory)
+ * toc
+ * list
+
+`make install' will install all of these.  You may want to set
+TMACDIR, BINDIR and MANDIR before installing.
+
+--- Summary ---
+
+* Mu is a simple and modern troff macro package.  It is divided
+  into two files:
+
+    u.tmac -- base macros
+    ux.tmac -- extra macros (optional)
+
+* Toc provides a simple method of creating forward references, such
+  as tables of contents, in troff documents.  It consists of a
+  shell script and a macro package:
+
+    toc -- runs troff in multiple passes
+    toc.tmac -- macros to be used with toc
+
+* List provides a way to include source code in troff documents
+  without needing to escape special characters.  It consists of a
+  single Perl script:
+
+    list -- escapes text between .l( and .l)