Summary Files Commits Branches @commit @diff @stats
path: root / README.md
diff options
context:
space:
mode:
Commitdd3e46487b980fd0f2b9aa017b27e1af2f2bd07a (patch)
Author
 Haelwenn (lanodan) Monnier <contact@hacktivis.me>
2021-10-01 21:19:58 +0200
Committer
 Haelwenn (lanodan) Monnier <contact@hacktivis.me>
2021-10-01 21:35:57 +0200
Files125e4b3998670ba762d799db49a6170e90f17427 /README.md
goodwolf-dd3e46487b980fd0f2b9aa017b27e1af2f2bd07a.tar
goodwolf-dd3e46487b980fd0f2b9aa017b27e1af2f2bd07a.tar.gz
goodwolf-dd3e46487b980fd0f2b9aa017b27e1af2f2bd07a.zip
Parent76c98a18dfe8459c09ee051c8860a406c527687b (diff)
Make: Add manpage linting
mandb / GNU groff seems to have less tolerance than mandoc for rendering slightly broken manpages, which is rather annoying in my case.
1 files changed, 3 insertions, 1 deletions
-rw-r--r--README.md4
diff --git a/README.md b/README.md
index 5f61b0a..e5205e1 100644
--- a/README.md
+++ b/README.md
@@ -53,12 +53,14 @@ You need to have gettext installed. If you want a GUI, poedit exists and Weblate
## Manual Installation
Dependencies are:
+- POSIX-compatible Shell (ie. mrsh, dash, lksh)
- C11 Compiler (such as clang or gcc)
- [WebKitGTK](https://webkitgtk.org/), only the latest stable(2.32.0+) is supported
- [libxml-2.0](http://www.xmlsoft.org/), no known version limitation
- POSIX make with extension for shell in variables (works with GNU, {Net,Free,Open}BSD)
- A pkg-config implementation (pkgconf is recommended)
-- (optionnal) gettext implementation (such as GNU Gettext)
+- (optional) gettext implementation (such as GNU Gettext)
+- (optional, test) [mandoc](https://mdocml.bsd.lv/) (the command) for linting the manpage
Compilation is done with `./configure && make`, install with `make install` (`DESTDIR` and `PREFIX` environment variables are supported, amongs other common ones). An example AppArmor profile is provided at `usr.bin.badwolf`, please do some long runtime checks before shipping it or a modified version, help can be provided but with no support.