Change README from Markdown to rST (for uniformity and to avoid GitHub pages caching problems).

Also regenerate HTML.

Signed-off-by: Daira Hopwood <daira@jacaranda.org>
This commit is contained in:
Daira Hopwood 2019-08-24 13:56:44 +01:00
parent 9040eed545
commit 2815bee6f9
9 changed files with 250 additions and 106 deletions

View File

@ -2,16 +2,19 @@
# sudo apt-get install python-pip
# sudo pip install rst2html5
.PHONY: all
all:
$(MAKE) index.rst
$(MAKE) index.html $(addsuffix .html,$(basename $(wildcard *.rst)))
%.html: %.rst
$(eval TITLE=$(shell echo '$(basename $<)' | sed -r 's|zip-0{0,3}|ZIP |'): $(shell grep '^\s*Title: ' $< | sed 's|\s*Title: ||'))
$(eval TITLE=$(shell echo '$(basename $<)' | sed -r 's|zip-0{0,3}|ZIP |'): $(shell grep -E '^(\.\.)?\s*Title:' $< |sed 's|.*Title:\s*||'))
rst2html5 -v --title="$(TITLE)" $< >$@
sed -i 's|</head>|<link rel="stylesheet" href="css/zip-style.css"><link rel="stylesheet" href="assets/css/style.css"></head>|' $@
index.rst: makeindex.sh index.template
./makeindex.sh | cat index.template - >index.rst
all: $(addsuffix .html,$(basename $(wildcard zip-*.rst)))
./makeindex.sh | cat README-template.md - >README.md
.PHONY: clean
clean:
rm -f zip-*.html
default: all
rm -f index.rst $(addsuffix .html,$(basename $(wildcard *.rst)))

View File

@ -1,39 +0,0 @@
zips
====
Specifications and Zcash Improvement Proposals for the
[Zcash cryptocurrency](https://z.cash/).
Participation in the Zcash project is subject to a
[Code of Conduct](https://github.com/zcash/zcash/blob/master/code_of_conduct.md).
NU3 ZIPs for consideration
--------------------------
This is the list of ZIPs that were under consideration for the NU3 upgrade (around ~April 2020).
- [Sapling Anchor Deduplication within Transactions](https://github.com/zcash/zips/blob/master/zip-0210.rst)
- [Disabling Addition of New Value to the Sprout Value Pool](https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst)
- [Add Bolt support](https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst)
- [Shielded Coinbase](https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst)
- [Enable Staked Polling from the Sapling Pool](https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst)
- [Adding MMR Proofs to Block Headers, and their use in the FlyClient Protocol](https://github.com/therealyingtong/zips/blob/master/zip-0221.rst)
- [Multisig](https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst)
- [Transfer Sapling Ephemeral Secret to Recipient in Note Plaintext](https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst)
Deadlines for NU4
-----------------
| Event | Date |
|-------|------|
| ZIP draft submission deadline | August 31, 2019 |
| Feature selection done | October 31, 2019 |
| Testnet beta code release | March 31, 2020 |
| Testnet activation | May 31, 2020 |
| Mainnet activation | October 2020 |
License
-------
Unless otherwise stated in this repository's individual files, the contents of this repository are released under the terms of the MIT license.
See [COPYING](COPYING) for more information or see http://opensource.org/licenses/MIT.

View File

@ -1,3 +1,7 @@
---
permalink: /index.html
---
zips
====
@ -6,56 +10,3 @@ Specifications and Zcash Improvement Proposals for the
Participation in the Zcash project is subject to a
[Code of Conduct](https://github.com/zcash/zcash/blob/master/code_of_conduct.md).
NU3 ZIPs for consideration
--------------------------
This is the list of ZIPs that were under consideration for the NU3 upgrade (around ~April 2020).
- [Sapling Anchor Deduplication within Transactions](https://github.com/zcash/zips/blob/master/zip-0210.rst)
- [Disabling Addition of New Value to the Sprout Value Pool](https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst)
- [Add Bolt support](https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst)
- [Shielded Coinbase](https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst)
- [Enable Staked Polling from the Sapling Pool](https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst)
- [Adding MMR Proofs to Block Headers, and their use in the FlyClient Protocol](https://github.com/therealyingtong/zips/blob/master/zip-0221.rst)
- [Multisig](https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst)
- [Transfer Sapling Ephemeral Secret to Recipient in Note Plaintext](https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst)
Deadlines for NU4
-----------------
| Event | Date |
|-------|------|
| ZIP draft submission deadline | August 31, 2019 |
| Feature selection done | October 31, 2019 |
| Testnet beta code release | March 31, 2020 |
| Testnet activation | May 31, 2020 |
| Mainnet activation | October 2020 |
License
-------
Unless otherwise stated in this repository's individual files, the contents of this repository are released under the terms of the MIT license.
See [COPYING](COPYING) for more information or see http://opensource.org/licenses/MIT.
Index of ZIPs
-------------
| ZIP | Title | Status |
|-----|-------|--------|
| 0 | [ZIP Process](zip-0000) | Active |
| 32 | [Shielded Hierarchical Deterministic Wallets](zip-0032) | Final |
| 143 | [Transaction Signature Verification for Overwinter](zip-0143) | Final |
| 200 | [Network Upgrade Mechanism](zip-0200) | Final |
| 201 | [Network Peer Management for Overwinter](zip-0201) | Final |
| 202 | [Version 3 Transaction Format for Overwinter](zip-0202) | Final |
| 203 | [Transaction Expiry](zip-0203) | Final |
| 205 | [Deployment of the Sapling Network Upgrade](zip-0205) | Final |
| 206 | [Deployment of the Blossom Network Upgrade](zip-0206) | Draft |
| ~207~ | ~[Split Founders' Reward](zip-0207)~ | Withdrawn |
| 208 | [Shorter Block Target Spacing](zip-0208) | Implemented |
| 209 | [Prohibit Negative Shielded Value Pool](zip-0209) | Final |
| 210 | [Sapling Anchor Deduplication within Transactions](zip-0210) | Draft |
| 243 | [Transaction Signature Verification for Sapling](zip-0243) | Final |
| 308 | [Sprout to Sapling Migration](zip-0308) | Final |
| guide | [{Something Short and To the Point}](zip-guide) | Draft |

View File

@ -8,6 +8,7 @@ a.footnote_reference::after { content: "]"; }
dd { margin-left: 2em !important; }
th, td { border: 1px solid black !important; }
td.left { text-align: left !important; }
table { display: block !important; padding-left: 2em !important; padding-bottom: 1em !important; }
th { padding-left: 0.8em !important; padding-right: 0.8em !important; background-color: #d8d8d8 !important; }
td { padding-left: 0.8em !important; padding-right: 0.8em !important; }

87
index.html Normal file
View File

@ -0,0 +1,87 @@
<!DOCTYPE html>
<html>
<head>
<title>index: Specifications and Zcash Improvement Proposals</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="css/zip-style.css"><link rel="stylesheet" href="assets/css/style.css"></head>
<body>
<section id="zips">
<h1>zips</h1>
<!-- Title: Specifications and Zcash Improvement Proposals -->
<p>Specifications and Zcash Improvement Proposals for the <a href="https://z.cash/">Zcash cryptocurrency</a>.</p>
<p>Participation in the Zcash project is subject to a <a href="https://github.com/zcash/zcash/blob/master/code_of_conduct.md">Code of Conduct</a>.</p>
<section id="nu3-zips-for-consideration">
<h2>NU3 ZIPs for consideration</h2>
<p>This is the list of ZIPs that were under consideration for the NU3 upgrade (around ~April 2020).</p>
<ul>
<li><a href="https://github.com/zcash/zips/blob/master/zip-0210.rst">Sapling Anchor Deduplication within Transactions</a></li>
<li><a href="https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst">Disabling Addition of New Value to the Sprout Value Pool</a></li>
<li><a href="https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst">Add Bolt support</a></li>
<li><a href="https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst">Shielded Coinbase</a></li>
<li><a href="https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst">Enable Staked Polling from the Sapling Pool</a></li>
<li><a href="https://github.com/therealyingtong/zips/blob/master/zip-0221.rst">Adding MMR Proofs to Block Headers, and their use in the FlyClient Protocol</a></li>
<li><a href="https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst">Multisig</a></li>
<li><a href="https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst">Transfer Sapling Ephemeral Secret to Recipient in Note Plaintext</a></li>
</ul>
</section>
<section id="deadlines-for-nu4">
<h2>Deadlines for NU4</h2>
<table>
<thead>
<tr>
<th>Event</th>
<th>Date</th>
</tr>
</thead>
<tbody>
<tr>
<td>ZIP draft submission deadline</td>
<td>August 31, 2019</td>
</tr>
<tr>
<td>Feature selection done</td>
<td>October 31, 2019</td>
</tr>
<tr>
<td>Testnet beta code release</td>
<td>March 31, 2020</td>
</tr>
<tr>
<td>Testnet activation</td>
<td>May 31, 2020</td>
</tr>
<tr>
<td>Mainnet activation</td>
<td>October 2020</td>
</tr>
</tbody>
</table>
</section>
<section id="license">
<h2>License</h2>
<p>Unless otherwise stated in this repositorys individual files, the contents of this repository are released under the terms of the MIT license. See <a href="COPYING">COPYING</a> for more information or see <a href="https://opensource.org/licenses/MIT">https://opensource.org/licenses/MIT</a> .</p>
</section>
<section id="index-of-zips">
<h2>Index of ZIPs</h2>
<embed><table>
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
<tr> <td>0</td> <td class="left"><a href="zip-0000">ZIP Process</a></td> <td>Active</td>
<tr> <td>32</td> <td class="left"><a href="zip-0032">Shielded Hierarchical Deterministic Wallets</a></td> <td>Final</td>
<tr> <td>143</td> <td class="left"><a href="zip-0143">Transaction Signature Verification for Overwinter</a></td> <td>Final</td>
<tr> <td>200</td> <td class="left"><a href="zip-0200">Network Upgrade Mechanism</a></td> <td>Final</td>
<tr> <td>201</td> <td class="left"><a href="zip-0201">Network Peer Management for Overwinter</a></td> <td>Final</td>
<tr> <td>202</td> <td class="left"><a href="zip-0202">Version 3 Transaction Format for Overwinter</a></td> <td>Final</td>
<tr> <td>203</td> <td class="left"><a href="zip-0203">Transaction Expiry</a></td> <td>Final</td>
<tr> <td>205</td> <td class="left"><a href="zip-0205">Deployment of the Sapling Network Upgrade</a></td> <td>Final</td>
<tr> <td>206</td> <td class="left"><a href="zip-0206">Deployment of the Blossom Network Upgrade</a></td> <td>Draft</td>
<tr> <td><strike>207</strike></td> <td class="left"><strike><a href="zip-0207">Split Founders' Reward</a></strike></td> <td>Withdrawn</td>
<tr> <td>208</td> <td class="left"><a href="zip-0208">Shorter Block Target Spacing</a></td> <td>Implemented</td>
<tr> <td>209</td> <td class="left"><a href="zip-0209">Prohibit Negative Shielded Value Pool</a></td> <td>Final</td>
<tr> <td>210</td> <td class="left"><a href="zip-0210">Sapling Anchor Deduplication within Transactions</a></td> <td>Draft</td>
<tr> <td>243</td> <td class="left"><a href="zip-0243">Transaction Signature Verification for Sapling</a></td> <td>Final</td>
<tr> <td>308</td> <td class="left"><a href="zip-0308">Sprout to Sapling Migration</a></td> <td>Final</td>
<tr> <td>guide</td> <td class="left"><a href="zip-guide">{Something Short and To the Point}</a></td> <td>Draft</td>
</table></embed></section>
</section>
</body>
</html>

82
index.rst Normal file
View File

@ -0,0 +1,82 @@
zips
====
.. Title: Specifications and Zcash Improvement Proposals
Specifications and Zcash Improvement Proposals for the `Zcash
cryptocurrency <https://z.cash/>`__.
Participation in the Zcash project is subject to a `Code of
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
NU3 ZIPs for consideration
--------------------------
This is the list of ZIPs that were under consideration for the NU3
upgrade (around ~April 2020).
- `Sapling Anchor Deduplication within
Transactions <https://github.com/zcash/zips/blob/master/zip-0210.rst>`__
- `Disabling Addition of New Value to the Sprout Value
Pool <https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst>`__
- `Add Bolt
support <https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst>`__
- `Shielded
Coinbase <https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst>`__
- `Enable Staked Polling from the Sapling
Pool <https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst>`__
- `Adding MMR Proofs to Block Headers, and their use in the FlyClient
Protocol <https://github.com/therealyingtong/zips/blob/master/zip-0221.rst>`__
- `Multisig <https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst>`__
- `Transfer Sapling Ephemeral Secret to Recipient in Note
Plaintext <https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst>`__
Deadlines for NU4
-----------------
+-------------------------------+------------------+
| Event | Date |
+===============================+==================+
| ZIP draft submission deadline | August 31, 2019 |
+-------------------------------+------------------+
| Feature selection done | October 31, 2019 |
+-------------------------------+------------------+
| Testnet beta code release | March 31, 2020 |
+-------------------------------+------------------+
| Testnet activation | May 31, 2020 |
+-------------------------------+------------------+
| Mainnet activation | October 2020 |
+-------------------------------+------------------+
License
-------
Unless otherwise stated in this repositorys individual files, the
contents of this repository are released under the terms of the MIT
license. See `COPYING <COPYING>`__ for more information or see
https://opensource.org/licenses/MIT .
Index of ZIPs
-------------
.. raw:: html
<embed><table>
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
<tr> <td>0</td> <td class="left"><a href="zip-0000">ZIP Process</a></td> <td>Active</td>
<tr> <td>32</td> <td class="left"><a href="zip-0032">Shielded Hierarchical Deterministic Wallets</a></td> <td>Final</td>
<tr> <td>143</td> <td class="left"><a href="zip-0143">Transaction Signature Verification for Overwinter</a></td> <td>Final</td>
<tr> <td>200</td> <td class="left"><a href="zip-0200">Network Upgrade Mechanism</a></td> <td>Final</td>
<tr> <td>201</td> <td class="left"><a href="zip-0201">Network Peer Management for Overwinter</a></td> <td>Final</td>
<tr> <td>202</td> <td class="left"><a href="zip-0202">Version 3 Transaction Format for Overwinter</a></td> <td>Final</td>
<tr> <td>203</td> <td class="left"><a href="zip-0203">Transaction Expiry</a></td> <td>Final</td>
<tr> <td>205</td> <td class="left"><a href="zip-0205">Deployment of the Sapling Network Upgrade</a></td> <td>Final</td>
<tr> <td>206</td> <td class="left"><a href="zip-0206">Deployment of the Blossom Network Upgrade</a></td> <td>Draft</td>
<tr> <td><strike>207</strike></td> <td class="left"><strike><a href="zip-0207">Split Founders' Reward</a></strike></td> <td>Withdrawn</td>
<tr> <td>208</td> <td class="left"><a href="zip-0208">Shorter Block Target Spacing</a></td> <td>Implemented</td>
<tr> <td>209</td> <td class="left"><a href="zip-0209">Prohibit Negative Shielded Value Pool</a></td> <td>Final</td>
<tr> <td>210</td> <td class="left"><a href="zip-0210">Sapling Anchor Deduplication within Transactions</a></td> <td>Draft</td>
<tr> <td>243</td> <td class="left"><a href="zip-0243">Transaction Signature Verification for Sapling</a></td> <td>Final</td>
<tr> <td>308</td> <td class="left"><a href="zip-0308">Sprout to Sapling Migration</a></td> <td>Final</td>
<tr> <td>guide</td> <td class="left"><a href="zip-guide">{Something Short and To the Point}</a></td> <td>Draft</td>
</table></embed>

57
index.template Normal file
View File

@ -0,0 +1,57 @@
zips
====
.. Title: Specifications and Zcash Improvement Proposals
Specifications and Zcash Improvement Proposals for the `Zcash
cryptocurrency <https://z.cash/>`__.
Participation in the Zcash project is subject to a `Code of
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
NU3 ZIPs for consideration
--------------------------
This is the list of ZIPs that were under consideration for the NU3
upgrade (around ~April 2020).
- `Sapling Anchor Deduplication within
Transactions <https://github.com/zcash/zips/blob/master/zip-0210.rst>`__
- `Disabling Addition of New Value to the Sprout Value
Pool <https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst>`__
- `Add Bolt
support <https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst>`__
- `Shielded
Coinbase <https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst>`__
- `Enable Staked Polling from the Sapling
Pool <https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst>`__
- `Adding MMR Proofs to Block Headers, and their use in the FlyClient
Protocol <https://github.com/therealyingtong/zips/blob/master/zip-0221.rst>`__
- `Multisig <https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst>`__
- `Transfer Sapling Ephemeral Secret to Recipient in Note
Plaintext <https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst>`__
Deadlines for NU4
-----------------
+-------------------------------+------------------+
| Event | Date |
+===============================+==================+
| ZIP draft submission deadline | August 31, 2019 |
+-------------------------------+------------------+
| Feature selection done | October 31, 2019 |
+-------------------------------+------------------+
| Testnet beta code release | March 31, 2020 |
+-------------------------------+------------------+
| Testnet activation | May 31, 2020 |
+-------------------------------+------------------+
| Mainnet activation | October 2020 |
+-------------------------------+------------------+
License
-------
Unless otherwise stated in this repositorys individual files, the
contents of this repository are released under the terms of the MIT
license. See `COPYING <COPYING>`__ for more information or see
https://opensource.org/licenses/MIT .

View File

@ -5,14 +5,16 @@ cat <<EndOfHeader
Index of ZIPs
-------------
| ZIP | Title | Status |
|-----|-------|--------|
.. raw:: html
<embed><table>
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
EndOfHeader
for zipfile in *.rst; do
for zipfile in zip-*.rst; do
if grep -E '^\s*Status:\s*(Withdrawn|Rejected|Obsolete)' $zipfile >/dev/null; then
echo "| ~`basename $zipfile .rst | sed -r 's@zip-0{0,3}@@'`~ | ~[`grep '^\s*Title:' $zipfile | sed 's@\s*Title:\s*@@'`](`basename $zipfile .rst`)~ | `grep '^\s*Status:' $zipfile | sed 's@\s*Status:\s*@@'` |"
echo " <tr> <td><strike>`basename $zipfile .rst | sed -r 's@zip-0{0,3}@@'`</strike></td> <td class=\"left\"><strike><a href=\"`basename $zipfile .rst`\">`grep '^\s*Title:' $zipfile | sed 's@\s*Title:\s*@@'`</a></strike></td> <td>`grep '^\s*Status:' $zipfile | sed 's@\s*Status:\s*@@'`</td>"
else
echo "| `basename $zipfile .rst | sed -r 's@zip-0{0,3}@@'` | [`grep '^\s*Title:' $zipfile | sed 's@\s*Title:\s*@@'`](`basename $zipfile .rst`) | `grep '^\s*Status:' $zipfile | sed 's@\s*Status:\s*@@'` |"
echo " <tr> <td>`basename $zipfile .rst | sed -r 's@zip-0{0,3}@@'`</td> <td class=\"left\"><a href=\"`basename $zipfile .rst`\">`grep '^\s*Title:' $zipfile | sed 's@\s*Title:\s*@@'`</a></td> <td>`grep '^\s*Status:' $zipfile | sed 's@\s*Status:\s*@@'`</td>"
fi
done
echo " </table></embed>"

View File

@ -44,7 +44,7 @@ License: BSD-2-Clause</pre>
</section>
<section id="zip-editors">
<h3>ZIP Editors</h3>
<p>The current ZIP Editors are Daira Hopwood, representing the Electric Coin Company, and Josh Cincinnati, representing the Zcash Foundation. Both can be reached at <a href="mailto:zips@z.cash">zips@z.cash</a> . The current design of the ZIP Process dictates that there are always at least two ZIP Editors: one from the Electric Coin Company and one from the Zcash Foundation. Additional Editors may be selected by consensus among the current Editors.</p>
<p>The current ZIP Editors are Daira Hopwood, representing the Electric Coin Company, and George Tankersley, representing the Zcash Foundation. Both can be reached at <a href="mailto:zips@z.cash">zips@z.cash</a> . The current design of the ZIP Process dictates that there are always at least two ZIP Editors: one from the Electric Coin Company and one from the Zcash Foundation. Additional Editors may be selected by consensus among the current Editors.</p>
</section>
<section id="zip-editor-responsibilities-workflow">
<h3>ZIP Editor Responsibilities &amp; Workflow</h3>