mirror of https://github.com/zcash/zips.git
In protocol/README.rst: Update build dependency documentation for Debian Bullseye,
mention `make linkcheck`, and correct the description of `make all`. Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
parent
8e59342637
commit
1c1a42bb27
2
Makefile
2
Makefile
|
@ -1,5 +1,5 @@
|
|||
# Dependencies:
|
||||
# sudo apt-get install python3-pip pandoc perl sed
|
||||
# sudo apt install python3-pip pandoc perl sed
|
||||
# sudo pip3 install rst2html5
|
||||
|
||||
.PHONY: all all-zips release protocol discard
|
||||
|
|
|
@ -6,8 +6,17 @@ Build dependencies on Debian-based systems include, at least:
|
|||
|
||||
.. code::
|
||||
|
||||
apt-get install texlive texlive-science texlive-fonts-extra \
|
||||
texlive-generic-recommended texlive-bibtex-extra biber latexmk perl awk
|
||||
apt install python3-pip pandoc perl sed perl \
|
||||
texlive texlive-science texlive-fonts-extra texlive-bibtex-extra biber latexmk
|
||||
|
||||
Prior to Bullseye you may also need the ``awk`` and ``texlive-generic-recommended``
|
||||
packages.
|
||||
|
||||
For link checking, you will also need the following Python packages:
|
||||
|
||||
.. code::
|
||||
|
||||
pip3 install rst2html5 certifi PyPDF2
|
||||
|
||||
|
||||
Building
|
||||
|
@ -23,8 +32,10 @@ Use:
|
|||
Sapling upgrades (``sapling.pdf``);
|
||||
* ``make sprout`` to make a version of the specification that does not
|
||||
include Overwinter or Sapling (``sprout.pdf``).
|
||||
* ``make linkcheck`` (in the root of the repo) to build everything and also
|
||||
perform link checking. This will access the network.
|
||||
|
||||
``make all`` is equivalent to ``make nufour heartwood blossom sapling sprout``.
|
||||
``make all`` is equivalent to ``make nu5 canopy heartwood blossom sapling``.
|
||||
|
||||
By default these use ``latexmk``. If you have trouble getting ``latexmk`` to
|
||||
work, you can instead use ``make nolatexmk-sapling``, etc. That is not the
|
||||
|
|
|
@ -14677,6 +14677,9 @@ Peter Newell's illustration of the Jubjub bird, from \cite{Carroll1902}.
|
|||
a \unifiedPaymentAddress.
|
||||
\item Replace ResearchGate links for \cite{CDvdG1987} and \cite{BDPA2007} with
|
||||
alternatives that do not cause false-positive link checker errors.
|
||||
\item In \texttt{protocol/README.rst}: update the build dependency documentation
|
||||
for Debian Bullseye, mention \texttt{make linkcheck}, and correct the
|
||||
description of \texttt{make all}.
|
||||
\end{itemize}
|
||||
|
||||
|
||||
|
|
|
@ -118,7 +118,7 @@ Valid reStructuredText
|
|||
This is optional before publishing a PR, but to check whether a document is valid
|
||||
reStructuredText, first install ``rst2html5``. E.g. on Debian-based distros::
|
||||
|
||||
sudo apt-get install python3-pip pandoc perl sed
|
||||
sudo apt install python3-pip pandoc perl sed
|
||||
sudo pip3 install rst2html5
|
||||
|
||||
Then, with ``zip-xxxx.rst`` in the root directory of a clone of this repo, run::
|
||||
|
|
Loading…
Reference in New Issue