From d397ec65aac136557d795c2e912c7f9985050edd Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Thu, 11 Nov 2021 20:59:32 +0100 Subject: add built instructions for manpage --- .gitignore | 3 +++ Makefile | 16 ++++++++++++++++ README.rst | 8 +++++++- 3 files changed, 26 insertions(+), 1 deletion(-) create mode 100644 Makefile diff --git a/.gitignore b/.gitignore index 2510987..ae0df3a 100644 --- a/.gitignore +++ b/.gitignore @@ -12,3 +12,6 @@ todo # cargo junk Cargo.lock + +# manpage +doc/vtcol.1.gz diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..013dc99 --- /dev/null +++ b/Makefile @@ -0,0 +1,16 @@ +manpage = doc/vtcol.1.gz + +cargo-target = ./target + +$(manpage): doc/vtcol.rst + rst2man $< |gzip > $@ + +man: $(manpage) + +doc: man + +clean: + rm -f -- $(manpage) + rm -rf -- $(cargo-target) + +.PHONY: clean diff --git a/README.rst b/README.rst index 1809902..21b80b2 100644 --- a/README.rst +++ b/README.rst @@ -62,7 +62,13 @@ Building Use Cargo to obtain a binary: :: - cargo build + $ cargo build + +To generate the manpage, run :: + + $ make man + +*rst2man* from the *Docutils* suite needs to be installed for this. Background ---------- -- cgit v1.2.3