aboutsummaryrefslogtreecommitdiff
path: root/docs/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Readme.md')
-rw-r--r--docs/Readme.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/Readme.md b/docs/Readme.md
new file mode 100644
index 000000000..4514afa77
--- /dev/null
+++ b/docs/Readme.md
@@ -0,0 +1,21 @@
+# Build the Docs
+
+## Directory Structure
+
+| | Directory |
+| ------------------------------------ | --------------------------- |
+| Markdown source for man pages | docs/source/markdown/ |
+| man pages aliases as .so files | docs/source/markdown/links/ |
+| restructured text for readthedocs.io | docs/rst/ |
+| target for output | docs/build |
+| man pages | docs/build/man |
+| remote linux man pages | docs/build/remote/linux |
+| remote darwin man pages | docs/build/remote/darwin |
+| remote windows html pages | docs/build/remote/windows |
+
+## Support files
+
+| | |
+| ------------------------------------ | --------------------------- |
+| docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform |
+| docs/links-to-html.lua | pandoc filter to do aliases for html files | \ No newline at end of file