From c39dea4bf977643c36c980c4b6f661d4cd85e791 Mon Sep 17 00:00:00 2001 From: John Ankarstrom Date: Thu, 1 Jul 2021 19:43:35 +0200 Subject: Add plain-text README --- README | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README 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) -- cgit v1.2.3