summaryrefslogtreecommitdiff
path: root/doc/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'doc/README.md')
-rw-r--r--doc/README.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md
new file mode 100644
index 00000000..2b87217d
--- /dev/null
+++ b/doc/README.md
@@ -0,0 +1,4 @@
+Manual Pages and Other Documentation
+=====
+
+To build the Linux/Unix manual pages type "./build.sh." You'll need NodeJS since if it's not here already the build script will pull [marked-man](https://github.com/kapouer/marked-man), which is a MarkDown to ROFF/man converter. We pre-build and ship the compiled man pages, so running build.sh is not essential unless the source MarkDown files have changed.