diff --git a/README.template b/README.template index 111eb1a22..9dd886d14 100644 --- a/README.template +++ b/README.template @@ -43,6 +43,25 @@ and double-check the generated ``rendered/draft-*.html`` file before filing a Pu See `here `__ for the project dependencies. +Building with Podman +~~~~~~~~~~~~~~~~~~~~ + +To build the rendered HTML without installing dependencies locally, use +`Podman `__ 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 ------------------------------- diff --git a/render-via-docker.sh b/render-via-docker.sh index c0fe0947e..53487904b 100755 --- a/render-via-docker.sh +++ b/render-via-docker.sh @@ -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"