zec
/
zips
mirror of https://github.com/zcash/zips.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update protocol/README.rst for Blossom changes. 

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2019-04-18 16:39:08 +01:00
parent 13b84cdb0f
commit 3c0fd3f56c
1 changed files with 13 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
protocol/README.rst
View File

@ -15,19 +15,21 @@ Building
Use:
* ``make sapling`` to make the draft specification for the Overwinter and
Sapling upgrades (``sapling.pdf``);
* ``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.
By default these use ``latexmk``, which does not work on all systems.
Use ``make nolatexmk-pdf`` or ``make nolatexmk-sapling`` if you run into
Use ``make nolatexmk-sapling`` or ``make nolatexmk-sprout`` if you run into
problems with ``latexmk``, but 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`` or ``make pvcsprout``.
``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.
@ -39,9 +41,10 @@ Optionally, you can use `Péter Szabó <https://github.com/pts>`_'s
Use:
* ``make optsapling`` to make an optimized version of ``sapling.pdf``;
* ``make optsapling`` to make an optimized version of ``protocol.pdf``;
* ``make optblossom`` to make an optimized version of ``blossom.pdf``;
* ``make optsprout`` to make an optimized version of ``sprout.pdf``;
* ``make optimized`` to make both.
* ``make optimized`` to make all optimized PDFs.
This will probably only work on Linux. The first time one of these
targets is run, it will automatically clone and build the necessary
@ -59,10 +62,10 @@ To convert to HTML you will first need to install ``pdf2htmlEX``. On Debian:
apt-get install pdf2htmlex
Then use ``make html`` (or ``make optimized html``) to convert both PDFs.
Then use ``make html`` (or ``make optimized html``) to convert all PDFs.
The results are placed in the ``html`` directory at ``html/sapling.html``
and ``html/sprout.html``.
The results are placed in the ``html`` directory at ``html/sapling.html``,
``html/blossom.html``, and ``html/sprout.html``.
See `<https://github.com/zcash/zips/issues/127>`_ for limitations of
this conversion.