Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions README.template
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,25 @@ and double-check the generated ``rendered/draft-*.html`` file before filing a Pu
See `here <protocol/README.rst>`__ for the project dependencies.


Building with Podman
~~~~~~~~~~~~~~~~~~~~

To build the rendered HTML without installing dependencies locally, use
`Podman <https://podman.io/>`__ with the included ``Dockerfile``:

.. code::

podman build -t zcash-zips-render .
podman run --rm --userns=keep-id -v "$(pwd):/zips" zcash-zips-render

The ``--userns=keep-id`` flag ensures that rendered files are owned by your
user rather than root. To render only the ZIPs (skipping protocol PDFs):

.. code::

podman run --rm --userns=keep-id -v "$(pwd):/zips" zcash-zips-render all-zips


Settled Mainnet Network Upgrade
-------------------------------

Expand Down
4 changes: 2 additions & 2 deletions render-via-docker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ set -efuxo pipefail

TAG='zcash-zips-render'

docker build -t "$TAG" .
docker run -v "$(pwd):/zips" "$TAG"
podman build -t "$TAG" .
podman run --rm --userns=keep-id -v "$(pwd):/zips" "$TAG"