zips/protocol
Daira Hopwood ef987f67b2 Ensure that changing a Makefile rebuilds everything on the next run.
Also change the default target for protocol/Makefile to not build unconditionally.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
2020-03-10 16:43:19 +00:00
..
Makefile Ensure that changing a Makefile rebuilds everything on the next run. 2020-03-10 16:43:19 +00:00
README.rst Protocol spec Makefile improvements to suppress unneeded output. 2019-09-03 20:51:01 +01:00
heartwood.pdf Regenerate PDFs for protocol spec. 2020-02-13 14:18:01 +00:00
incremental_merkle.odg Change coin commitments in Merkle tree diagram back to cm. 2016-02-11 18:37:28 +00:00
incremental_merkle.png Update incremental Merkle tree diagram. 2020-02-02 16:46:34 +00:00
incremental_merkle.svg Update incremental Merkle tree diagram. 2020-02-02 16:46:34 +00:00
jubjub.png Add macros and Makefile support for building the Blossom specification. 2019-02-22 13:49:08 +00:00
key_components.png Change 'Payment address' to 'Shielded payment address' in key components diagrams. 2020-02-02 16:45:47 +00:00
key_components.svg Change 'Payment address' to 'Shielded payment address' in key components diagrams. 2020-02-02 16:45:47 +00:00
key_components_sapling.png Change 'Payment address' to 'Shielded payment address' in key components diagrams. 2020-02-02 16:45:47 +00:00
key_components_sapling.svg Change 'Payment address' to 'Shielded payment address' in key components diagrams. 2020-02-02 16:45:47 +00:00
latexmkrc Protocol spec: Initial index support. 2019-07-08 22:42:16 +01:00
mymakeindex.sh Protocol spec: Initial index support. 2019-07-08 22:42:16 +01:00
protocol.pdf Regenerate PDFs for protocol spec. 2020-02-13 14:18:01 +00:00
protocol.tex Resolve conflicts in the specification of memo fields by deferring to ZIP 302. 2020-02-13 14:13:10 +00:00
sapling.pdf Regenerate PDFs for protocol spec. 2020-02-13 14:18:01 +00:00
sprout.pdf Regenerate PDFs for protocol spec. 2020-02-13 14:18:01 +00:00
zcash.bib Resolve conflicts in the specification of memo fields by deferring to ZIP 302. 2020-02-13 14:13:10 +00:00

README.rst

==============================
 Zcash Protocol Specification
==============================

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


Building
--------

Use:

* ``make sapling`` to make the specification for the Overwinter and
  Sapling upgrades (``protocol.pdf``);
* ``make blossom`` to make the draft specification for the Blossom upgrade
  (``blossom.pdf``);
* ``make sprout`` to make a version of the specification that does not
  include Overwinter or Sapling.

``make all`` is equivalent to ``make sapling blossom sprout``.

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
preferred way of building because it may not run ``pdflatex`` enough times.

There is also support for using the incremental (``-pvc``) mode of
``latexmk`` to automatically rebuild when changes in the source files are
detected: ``make pvcsapling``, ``make pvcblossom``, or ``make pvcsprout``.
Manual intervention is still needed when there are LaTeX errors.


Alternative TeX engines
-----------------------

There is experimental support for building the specification using LuaTeX
or XeTeX; see the comments at the top of the `Makefile`. However, this will
`currently produce poor output <https://github.com/zcash/zips/issues/249>`_.
A warning is included below the Abstract to indicate this.