aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
index e055848..919618e 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,21 @@ sudo cp mkhint /usr/local/bin/mkhint
sudo cp mkhint.bash-completion /etc/bash-completion.d/mkhint
```
+### Man Page
+
+```bash
+sudo cp mkhint.1.gz /usr/local/man/man1/mkhint.1.gz
+```
+
+The man page is pre-built and committed. To regenerate it from source (requires
+pandoc):
+
+```bash
+pandoc mkhint.1.md -s -t man -o mkhint.1 && gzip -9 -n -f mkhint.1
+```
+
+`mkhint --help` is a compact summary; the man page holds the full reference.
+
### Dependencies
- `wget` — for downloading archives and calculating checksums