From 2d7efc21fdb401306d79210a0f312f0819e30e68 Mon Sep 17 00:00:00 2001 From: Karchnu Date: Fri, 7 Jan 2022 16:33:14 +0100 Subject: [PATCH] Readme: how to compile. --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index 5a012ce..f103f8b 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,22 @@ Furthermore, this repository includes: - source code highlight (via the `source-highlight` software and a script) - A makefile to automatically call every tool in right order; just type `make`! +# How to compile + +You need `groff` installed on your system, and `source-highlight` (or remove the right line in the makefile). + +Then: +```sh +make +``` + +If you have `entr` on your system, you can also recompile your file each time you modify it: +```sh +make serve +``` + +Read the makefile for more options. + # Preview https://t.karchnu.fr/doc/grofftut.pdf