From e4eb27bf9360d736c8f6d09b31f28749d699288a Mon Sep 17 00:00:00 2001 From: Karchnu Date: Fri, 7 Jan 2022 09:40:44 +0100 Subject: [PATCH] Add README. --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..745175c --- /dev/null +++ b/README.md @@ -0,0 +1,27 @@ +# Troff template (batteries included) + +This repository is an introduction to the good old tools to produce documents: + +- `roff` as the language to describe documents (`groff` is the implementation) +- `tbl` and **hdtbl** for tables +- `pic` for drawing images +- `grap` for drawing graphs +- `refer` for handling references and bibliography +- etc. + +It also includes a few examples of custom macros and images. + +Furthermore, this repository includes: + +- UTF-8 characters translation into ms macros (via a script) +- source code highlight (via the `source-highlight` software and a script) +- A makefile to automatically call every tool in right order; just type `make`! + +# Preview + +https://t.karchnu.fr/doc/grofftut.pdf + +# Limitations + +Images are poorly handled, and they aren't easily managed with `roff` by default. +Some macros exist to do it properly, but it still is to include in custom macros then to document.