Use, and document how to install, MultiMarkdown-6.

Signed-off-by: Daira-Emma Hopwood <daira@jacaranda.org>
zcash · Nov 19, 2024 · 6e1bc0b · 6e1bc0b
1 parent 098f9e8
commit 6e1bc0b
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 14 deletions.
diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
-# Dependencies: see zip-guide.rst and protocol/README.rst
+# Dependencies: see zips/zip-guide.rst and protocol/README.rst
 
-MARKDOWN_OPTION?=--pandoc
+MARKDOWN_OPTION?=--mmd
 
 .PHONY: all-zips all tag-release protocol all-protocol discard
 all-zips: .Makefile.uptodate

diff --git a/protocol/README.rst b/protocol/README.rst
@@ -6,7 +6,7 @@ Build dependencies on Debian-based systems include, at least:
 
 .. code::
 
-   apt install python3-pip pandoc perl sed perl \
+   apt install python3-pip perl sed cmake \
      texlive texlive-science texlive-fonts-extra texlive-bibtex-extra biber latexmk
 
 Prior to Bullseye you may also need the ``awk`` and ``texlive-generic-recommended``
@@ -16,7 +16,7 @@ For link checking, you will also need the following Python packages:
 
 .. code::
 
-   pip3 install docutils==0.19 rst2html5 certifi PyPDF2
+   pip3 install 'docutils==0.21.2' 'rst2html5==2.0.1' certifi PyPDF2
 
 
 Building

diff --git a/zips/zip-guide-markdown.md b/zips/zip-guide-markdown.md
@@ -177,11 +177,17 @@ or "SHOULD" conformance requirement is more appropriate.
 ## Valid markup
 
 This is optional before publishing a PR, but to check whether a document is valid
-reStructuredText or Markdown, first install `rst2html5` and `pandoc`. E.g. on
-Debian-based distros::
-
-    sudo apt install python3-pip pandoc perl sed
-    pip3 install docutils==0.19 rst2html5
+reStructuredText or Markdown, first install `docutils` and `rst2html5`, and
+build ``MultiMarkdown-6``. E.g. on Debian-based distros::
+
+    sudo apt install python3-pip perl sed cmake
+    pip3 install 'docutils==0.21.2' 'rst2html5==2.0.1'
+    git clone -b develop https://github.com/Electric-Coin-Company/MultiMarkdown-6
+    cd MultiMarkdown-6
+    make release
+    cd build
+    make
+    sudo make install
 
 Then, with `draft-myzip.rst` or `draft-myzip.md` in the root directory of a clone
 of this repo, run::

diff --git a/zips/zip-guide.rst b/zips/zip-guide.rst
@@ -186,11 +186,17 @@ Valid markup
 ------------
 
 This is optional before publishing a PR, but to check whether a document is valid
-reStructuredText or Markdown, first install ``rst2html5`` and ``pandoc``. E.g. on
-Debian-based distros::
-
-  sudo apt install python3-pip pandoc perl sed
-  pip3 install docutils==0.19 rst2html5
+reStructuredText or Markdown, first install ``docutils`` and ``rst2html5``, and
+build ``MultiMarkdown-6``. E.g. on Debian-based distros::
+
+  sudo apt install python3-pip perl sed cmake
+  pip3 install 'docutils==0.21.2' 'rst2html5==2.0.1'
+  git clone -b develop https://github.com/Electric-Coin-Company/MultiMarkdown-6
+  cd MultiMarkdown-6
+  make release
+  cd build
+  make
+  sudo make install
 
 Then, with ``draft-myzip.rst`` or ``draft-myzip.md`` in the root directory of a
 clone of this repo, run::