Skip to content

Commit 2815bee

Browse files
dairadaira
committed
Change README from Markdown to rST (for uniformity and to avoid GitHub pages caching problems).
Also regenerate HTML. Signed-off-by: Daira Hopwood <[email protected]>
1 parent 9040eed commit 2815bee

File tree

9 files changed

+250
-106
lines changed

9 files changed

+250
-106
lines changed

‎Makefile‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,19 @@
22
# sudo apt-get install python-pip
33
# sudo pip install rst2html5
44

5+
.PHONY: all
6+
all:
7+
$(MAKE) index.rst
8+
$(MAKE) index.html $(addsuffix .html,$(basename $(wildcard *.rst)))
9+
510
%.html: %.rst
6-
$(eval TITLE=$(shell echo '$(basename $<)' | sed -r 's|zip-0{0,3}|ZIP |'): $(shell grep '^\s*Title: ' $< | sed 's|\s*Title: ||'))
11+
$(eval TITLE=$(shell echo '$(basename $<)' | sed -r 's|zip-0{0,3}|ZIP |'): $(shell grep -E '^(\.\.)?\s*Title:' $< |sed 's|.*Title:\s*||'))
712
rst2html5 -v --title="$(TITLE)" $< >$@
813
sed -i 's|</head>|<link rel="stylesheet" href="css/zip-style.css"><link rel="stylesheet" href="assets/css/style.css"></head>|' $@
914

15+
index.rst: makeindex.sh index.template
16+
./makeindex.sh | cat index.template - >index.rst
1017

11-
all: $(addsuffix .html,$(basename $(wildcard zip-*.rst)))
12-
./makeindex.sh | cat README-template.md - >README.md
13-
18+
.PHONY: clean
1419
clean:
15-
rm -f zip-*.html
16-
17-
default: all
20+
rm -f index.rst $(addsuffix .html,$(basename $(wildcard *.rst)))

‎README-template.md‎

Lines changed: 0 additions & 39 deletions
This file was deleted.

‎README.md‎

Lines changed: 4 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
permalink: /index.html
3+
---
4+
15
zips
26
====
37

@@ -6,56 +10,3 @@ Specifications and Zcash Improvement Proposals for the
610

711
Participation in the Zcash project is subject to a
812
[Code of Conduct](https://github.com/zcash/zcash/blob/master/code_of_conduct.md).
9-
10-
NU3 ZIPs for consideration
11-
--------------------------
12-
13-
This is the list of ZIPs that were under consideration for the NU3 upgrade (around ~April 2020).
14-
15-
- [Sapling Anchor Deduplication within Transactions](https://github.com/zcash/zips/blob/master/zip-0210.rst)
16-
- [Disabling Addition of New Value to the Sprout Value Pool](https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst)
17-
- [Add Bolt support](https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst)
18-
- [Shielded Coinbase](https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst)
19-
- [Enable Staked Polling from the Sapling Pool](https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst)
20-
- [Adding MMR Proofs to Block Headers, and their use in the FlyClient Protocol](https://github.com/therealyingtong/zips/blob/master/zip-0221.rst)
21-
- [Multisig](https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst)
22-
- [Transfer Sapling Ephemeral Secret to Recipient in Note Plaintext](https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst)
23-
24-
Deadlines for NU4
25-
-----------------
26-
27-
| Event | Date |
28-
|-------|------|
29-
| ZIP draft submission deadline | August 31, 2019 |
30-
| Feature selection done | October 31, 2019 |
31-
| Testnet beta code release | March 31, 2020 |
32-
| Testnet activation | May 31, 2020 |
33-
| Mainnet activation | October 2020 |
34-
35-
License
36-
-------
37-
38-
Unless otherwise stated in this repository's individual files, the contents of this repository are released under the terms of the MIT license.
39-
See [COPYING](COPYING) for more information or see http://opensource.org/licenses/MIT.
40-
41-
Index of ZIPs
42-
-------------
43-
44-
| ZIP | Title | Status |
45-
|-----|-------|--------|
46-
| 0 | [ZIP Process](zip-0000) | Active |
47-
| 32 | [Shielded Hierarchical Deterministic Wallets](zip-0032) | Final |
48-
| 143 | [Transaction Signature Verification for Overwinter](zip-0143) | Final |
49-
| 200 | [Network Upgrade Mechanism](zip-0200) | Final |
50-
| 201 | [Network Peer Management for Overwinter](zip-0201) | Final |
51-
| 202 | [Version 3 Transaction Format for Overwinter](zip-0202) | Final |
52-
| 203 | [Transaction Expiry](zip-0203) | Final |
53-
| 205 | [Deployment of the Sapling Network Upgrade](zip-0205) | Final |
54-
| 206 | [Deployment of the Blossom Network Upgrade](zip-0206) | Draft |
55-
| ~207~ | ~[Split Founders' Reward](zip-0207)~ | Withdrawn |
56-
| 208 | [Shorter Block Target Spacing](zip-0208) | Implemented |
57-
| 209 | [Prohibit Negative Shielded Value Pool](zip-0209) | Final |
58-
| 210 | [Sapling Anchor Deduplication within Transactions](zip-0210) | Draft |
59-
| 243 | [Transaction Signature Verification for Sapling](zip-0243) | Final |
60-
| 308 | [Sprout to Sapling Migration](zip-0308) | Final |
61-
| guide | [{Something Short and To the Point}](zip-guide) | Draft |

‎css/zip-style.css‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ a.footnote_reference::after { content: "]"; }
88
dd { margin-left: 2em !important; }
99

1010
th, td { border: 1px solid black !important; }
11+
td.left { text-align: left !important; }
1112
table { display: block !important; padding-left: 2em !important; padding-bottom: 1em !important; }
1213
th { padding-left: 0.8em !important; padding-right: 0.8em !important; background-color: #d8d8d8 !important; }
1314
td { padding-left: 0.8em !important; padding-right: 0.8em !important; }

‎index.html‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<title>index: Specifications and Zcash Improvement Proposals</title>
5+
<meta charset="utf-8" />
6+
<link rel="stylesheet" href="css/zip-style.css"><link rel="stylesheet" href="assets/css/style.css"></head>
7+
<body>
8+
<section id="zips">
9+
<h1>zips</h1>
10+
<!-- Title: Specifications and Zcash Improvement Proposals -->
11+
<p>Specifications and Zcash Improvement Proposals for the <a href="https://z.cash/">Zcash cryptocurrency</a>.</p>
12+
<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>
13+
<section id="nu3-zips-for-consideration">
14+
<h2>NU3 ZIPs for consideration</h2>
15+
<p>This is the list of ZIPs that were under consideration for the NU3 upgrade (around ~April 2020).</p>
16+
<ul>
17+
<li><a href="https://github.com/zcash/zips/blob/master/zip-0210.rst">Sapling Anchor Deduplication within Transactions</a></li>
18+
<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>
19+
<li><a href="https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst">Add Bolt support</a></li>
20+
<li><a href="https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst">Shielded Coinbase</a></li>
21+
<li><a href="https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst">Enable Staked Polling from the Sapling Pool</a></li>
22+
<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>
23+
<li><a href="https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst">Multisig</a></li>
24+
<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>
25+
</ul>
26+
</section>
27+
<section id="deadlines-for-nu4">
28+
<h2>Deadlines for NU4</h2>
29+
<table>
30+
<thead>
31+
<tr>
32+
<th>Event</th>
33+
<th>Date</th>
34+
</tr>
35+
</thead>
36+
<tbody>
37+
<tr>
38+
<td>ZIP draft submission deadline</td>
39+
<td>August 31, 2019</td>
40+
</tr>
41+
<tr>
42+
<td>Feature selection done</td>
43+
<td>October 31, 2019</td>
44+
</tr>
45+
<tr>
46+
<td>Testnet beta code release</td>
47+
<td>March 31, 2020</td>
48+
</tr>
49+
<tr>
50+
<td>Testnet activation</td>
51+
<td>May 31, 2020</td>
52+
</tr>
53+
<tr>
54+
<td>Mainnet activation</td>
55+
<td>October 2020</td>
56+
</tr>
57+
</tbody>
58+
</table>
59+
</section>
60+
<section id="license">
61+
<h2>License</h2>
62+
<p>Unless otherwise stated in this repository’s 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>
63+
</section>
64+
<section id="index-of-zips">
65+
<h2>Index of ZIPs</h2>
66+
<embed><table>
67+
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
68+
<tr> <td>0</td> <td class="left"><a href="zip-0000">ZIP Process</a></td> <td>Active</td>
69+
<tr> <td>32</td> <td class="left"><a href="zip-0032">Shielded Hierarchical Deterministic Wallets</a></td> <td>Final</td>
70+
<tr> <td>143</td> <td class="left"><a href="zip-0143">Transaction Signature Verification for Overwinter</a></td> <td>Final</td>
71+
<tr> <td>200</td> <td class="left"><a href="zip-0200">Network Upgrade Mechanism</a></td> <td>Final</td>
72+
<tr> <td>201</td> <td class="left"><a href="zip-0201">Network Peer Management for Overwinter</a></td> <td>Final</td>
73+
<tr> <td>202</td> <td class="left"><a href="zip-0202">Version 3 Transaction Format for Overwinter</a></td> <td>Final</td>
74+
<tr> <td>203</td> <td class="left"><a href="zip-0203">Transaction Expiry</a></td> <td>Final</td>
75+
<tr> <td>205</td> <td class="left"><a href="zip-0205">Deployment of the Sapling Network Upgrade</a></td> <td>Final</td>
76+
<tr> <td>206</td> <td class="left"><a href="zip-0206">Deployment of the Blossom Network Upgrade</a></td> <td>Draft</td>
77+
<tr> <td><strike>207</strike></td> <td class="left"><strike><a href="zip-0207">Split Founders' Reward</a></strike></td> <td>Withdrawn</td>
78+
<tr> <td>208</td> <td class="left"><a href="zip-0208">Shorter Block Target Spacing</a></td> <td>Implemented</td>
79+
<tr> <td>209</td> <td class="left"><a href="zip-0209">Prohibit Negative Shielded Value Pool</a></td> <td>Final</td>
80+
<tr> <td>210</td> <td class="left"><a href="zip-0210">Sapling Anchor Deduplication within Transactions</a></td> <td>Draft</td>
81+
<tr> <td>243</td> <td class="left"><a href="zip-0243">Transaction Signature Verification for Sapling</a></td> <td>Final</td>
82+
<tr> <td>308</td> <td class="left"><a href="zip-0308">Sprout to Sapling Migration</a></td> <td>Final</td>
83+
<tr> <td>guide</td> <td class="left"><a href="zip-guide">{Something Short and To the Point}</a></td> <td>Draft</td>
84+
</table></embed></section>
85+
</section>
86+
</body>
87+
</html>

‎index.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
zips
2+
====
3+
4+
.. Title: Specifications and Zcash Improvement Proposals
5+
6+
Specifications and Zcash Improvement Proposals for the `Zcash
7+
cryptocurrency <https://z.cash/>`__.
8+
9+
Participation in the Zcash project is subject to a `Code of
10+
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
11+
12+
NU3 ZIPs for consideration
13+
--------------------------
14+
15+
This is the list of ZIPs that were under consideration for the NU3
16+
upgrade (around ~April 2020).
17+
18+
- `Sapling Anchor Deduplication within
19+
Transactions <https://github.com/zcash/zips/blob/master/zip-0210.rst>`__
20+
- `Disabling Addition of New Value to the Sprout Value
21+
Pool <https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst>`__
22+
- `Add Bolt
23+
support <https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst>`__
24+
- `Shielded
25+
Coinbase <https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst>`__
26+
- `Enable Staked Polling from the Sapling
27+
Pool <https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst>`__
28+
- `Adding MMR Proofs to Block Headers, and their use in the FlyClient
29+
Protocol <https://github.com/therealyingtong/zips/blob/master/zip-0221.rst>`__
30+
- `Multisig <https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst>`__
31+
- `Transfer Sapling Ephemeral Secret to Recipient in Note
32+
Plaintext <https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst>`__
33+
34+
Deadlines for NU4
35+
-----------------
36+
37+
+-------------------------------+------------------+
38+
| Event | Date |
39+
+===============================+==================+
40+
| ZIP draft submission deadline | August 31, 2019 |
41+
+-------------------------------+------------------+
42+
| Feature selection done | October 31, 2019 |
43+
+-------------------------------+------------------+
44+
| Testnet beta code release | March 31, 2020 |
45+
+-------------------------------+------------------+
46+
| Testnet activation | May 31, 2020 |
47+
+-------------------------------+------------------+
48+
| Mainnet activation | October 2020 |
49+
+-------------------------------+------------------+
50+
51+
License
52+
-------
53+
54+
Unless otherwise stated in this repository’s individual files, the
55+
contents of this repository are released under the terms of the MIT
56+
license. See `COPYING <COPYING>`__ for more information or see
57+
https://opensource.org/licenses/MIT .
58+
59+
Index of ZIPs
60+
-------------
61+
62+
.. raw:: html
63+
64+
<embed><table>
65+
<tr> <th>ZIP</th> <th>Title</th> <th>Status</th> </tr>
66+
<tr> <td>0</td> <td class="left"><a href="zip-0000">ZIP Process</a></td> <td>Active</td>
67+
<tr> <td>32</td> <td class="left"><a href="zip-0032">Shielded Hierarchical Deterministic Wallets</a></td> <td>Final</td>
68+
<tr> <td>143</td> <td class="left"><a href="zip-0143">Transaction Signature Verification for Overwinter</a></td> <td>Final</td>
69+
<tr> <td>200</td> <td class="left"><a href="zip-0200">Network Upgrade Mechanism</a></td> <td>Final</td>
70+
<tr> <td>201</td> <td class="left"><a href="zip-0201">Network Peer Management for Overwinter</a></td> <td>Final</td>
71+
<tr> <td>202</td> <td class="left"><a href="zip-0202">Version 3 Transaction Format for Overwinter</a></td> <td>Final</td>
72+
<tr> <td>203</td> <td class="left"><a href="zip-0203">Transaction Expiry</a></td> <td>Final</td>
73+
<tr> <td>205</td> <td class="left"><a href="zip-0205">Deployment of the Sapling Network Upgrade</a></td> <td>Final</td>
74+
<tr> <td>206</td> <td class="left"><a href="zip-0206">Deployment of the Blossom Network Upgrade</a></td> <td>Draft</td>
75+
<tr> <td><strike>207</strike></td> <td class="left"><strike><a href="zip-0207">Split Founders' Reward</a></strike></td> <td>Withdrawn</td>
76+
<tr> <td>208</td> <td class="left"><a href="zip-0208">Shorter Block Target Spacing</a></td> <td>Implemented</td>
77+
<tr> <td>209</td> <td class="left"><a href="zip-0209">Prohibit Negative Shielded Value Pool</a></td> <td>Final</td>
78+
<tr> <td>210</td> <td class="left"><a href="zip-0210">Sapling Anchor Deduplication within Transactions</a></td> <td>Draft</td>
79+
<tr> <td>243</td> <td class="left"><a href="zip-0243">Transaction Signature Verification for Sapling</a></td> <td>Final</td>
80+
<tr> <td>308</td> <td class="left"><a href="zip-0308">Sprout to Sapling Migration</a></td> <td>Final</td>
81+
<tr> <td>guide</td> <td class="left"><a href="zip-guide">{Something Short and To the Point}</a></td> <td>Draft</td>
82+
</table></embed>

‎index.template‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
zips
2+
====
3+
4+
.. Title: Specifications and Zcash Improvement Proposals
5+
6+
Specifications and Zcash Improvement Proposals for the `Zcash
7+
cryptocurrency <https://z.cash/>`__.
8+
9+
Participation in the Zcash project is subject to a `Code of
10+
Conduct <https://github.com/zcash/zcash/blob/master/code_of_conduct.md>`__.
11+
12+
NU3 ZIPs for consideration
13+
--------------------------
14+
15+
This is the list of ZIPs that were under consideration for the NU3
16+
upgrade (around ~April 2020).
17+
18+
- `Sapling Anchor Deduplication within
19+
Transactions <https://github.com/zcash/zips/blob/master/zip-0210.rst>`__
20+
- `Disabling Addition of New Value to the Sprout Value
21+
Pool <https://github.com/daira/zips/blob/disable-sprout-outputs/zip-0211.rst>`__
22+
- `Add Bolt
23+
support <https://github.com/boltlabs-inc/zips/blob/master/zip-bolt-support.rst>`__
24+
- `Shielded
25+
Coinbase <https://github.com/str4d/zips/blob/zip-str4d-shielded-coinbase/zip-0213.rst>`__
26+
- `Enable Staked Polling from the Sapling
27+
Pool <https://github.com/acityinohio/zips/blob/sapling-polling/zip-draft.rst>`__
28+
- `Adding MMR Proofs to Block Headers, and their use in the FlyClient
29+
Protocol <https://github.com/therealyingtong/zips/blob/master/zip-0221.rst>`__
30+
- `Multisig <https://github.com/omershlo/zips/blob/multisig/zip-multisig.rst>`__
31+
- `Transfer Sapling Ephemeral Secret to Recipient in Note
32+
Plaintext <https://github.com/ebfull/zips/blob/unlinkable-addrs/zip-seanbowe-esktransfer.rst>`__
33+
34+
Deadlines for NU4
35+
-----------------
36+
37+
+-------------------------------+------------------+
38+
| Event | Date |
39+
+===============================+==================+
40+
| ZIP draft submission deadline | August 31, 2019 |
41+
+-------------------------------+------------------+
42+
| Feature selection done | October 31, 2019 |
43+
+-------------------------------+------------------+
44+
| Testnet beta code release | March 31, 2020 |
45+
+-------------------------------+------------------+
46+
| Testnet activation | May 31, 2020 |
47+
+-------------------------------+------------------+
48+
| Mainnet activation | October 2020 |
49+
+-------------------------------+------------------+
50+
51+
License
52+
-------
53+
54+
Unless otherwise stated in this repository’s individual files, the
55+
contents of this repository are released under the terms of the MIT
56+
license. See `COPYING <COPYING>`__ for more information or see
57+
https://opensource.org/licenses/MIT .

0 commit comments

Comments
 (0)