aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJohn Ankarstrom <john@ankarstrom.se>2021-07-01 19:43:35 +0200
committerJohn Ankarstrom <john@ankarstrom.se>2021-07-01 19:43:35 +0200
commitc39dea4bf977643c36c980c4b6f661d4cd85e791 (patch)
tree72ef29b2f08e0737b8d026693924d9ea30c3f690
parentcb9b9ac3de7c47b303398dcf6458aa443caf349c (diff)
downloadmk-c39dea4bf977643c36c980c4b6f661d4cd85e791.tar.gz
Add plain-text README
-rw-r--r--README31
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)