summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorHiltjo Posthuma <hiltjo@codemadness.org>2015-01-02 15:13:12 +0100
committerHiltjo Posthuma <hiltjo@codemadness.org>2015-01-02 15:13:12 +0100
commitc61c37abf3b6236cd65690fe8a47bdcd9d66bc13 (patch)
tree9e5dc0baf8998373ca345e708dde72ef83a70eb9 /README
parent80f1550529e08e71c87e44b38d6cf53171737d57 (diff)
doc: use mandoc as source, pre-generate documentation
generate documentation in doc/ . Now there is no hard dependency on mandoc and systems that don't have it can just copy the files for now.
Diffstat (limited to 'README')
-rw-r--r--README7
1 files changed, 4 insertions, 3 deletions
diff --git a/README b/README
index 467faf2..b5ad626 100644
--- a/README
+++ b/README
@@ -9,9 +9,6 @@ Dependencies
- C compiler (C99).
- libc (recommended: C99 and POSIX >= 200809).
-- mandoc for documentation: http://mdocml.bsd.lv/ . If your host
- system doesn't have mandoc you can convert the pages to the legacy format
- with mandoc -Tman (make doc-oldman).
Optional dependencies
@@ -26,6 +23,10 @@ Optional dependencies
used by sfeed_update. If the text in your RSS/Atom feeds are already UTF-8
encoded then you don't need this. For an alternative minimal iconv
implementation: http://git.etalabs.net/cgit/noxcuse/tree/src/iconv.c
+- mandoc for documentation: http://mdocml.bsd.lv/ . If your host
+ system doesn't have mandoc you can copy the legacy man-pages from doc/man
+ to your $MANPATH. For the most up-to-date documentation you can convert
+ the pages to the legacy format with mandoc -Tman (make doc-oldman).
Platforms tested