From cae3eca269bede774114fa8cd6d531e62e8e8717 Mon Sep 17 00:00:00 2001 From: Cian Bagshaw Date: Sun, 14 Aug 2022 19:07:42 +0100 Subject: [PATCH] Added README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1e04ae9 --- /dev/null +++ b/README.md @@ -0,0 +1,38 @@ +# cv.tmac + +`Troff`/`Groff` macros for creating CV PDF documents. + +## Includes + +- header +- section headings +- columned lists +- timelines/dates +- (documentation in file!) + +## Invocation + +These macros cab be used with groff, simply by specifying through flag +arguments, the directory they are located, with `-M`, and their name (without +the extension) with `-m`, as in: + + $ groff -Tpdf -M . -m cv myFile.trf > myFile.pdf + +to specify the file `cv.tmac`, which is in the current directory and we want to +use it. Or, if installed (see below), we can simply run: + + $ groff -Tpdf -m cv myFile.trf > myFile.pdf + +## Installation + +A more permanent solution is to install them to a local `Troff`/`Groff` macro +directory, `~/.local/share/troff/tmac/`, which involves setting the `Groff` +environment variable `GROFF_TMAC_PATH`. + + $ cd + $ mkdir -p .local/share/troff/tmac + $ git clone https://git.cianb.xyz/cvTrf + $ cp cvTrf/cv.tmac .local/share/troff/tmac/ + $ echo export GROFF_TMAC_PATH="${HOME}/.local/share/troff/tmac/" >> .profile + $ source .profile + $ rm -rf TrfCv -- 2.20.1