Skip to content

Commit

Permalink
Merge pull request #114 from filecoin-project/spec-fix-sparse-factori…
Browse files Browse the repository at this point in the history
…zation-w-vector

fix: spec's sparse factorization w vector
  • Loading branch information
porcuquine committed Oct 7, 2021
2 parents bafd77a + 0355722 commit cf8c7ad
Show file tree
Hide file tree
Showing 4 changed files with 766 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,19 @@ At the time of the 1.0.0 release, Neptune on RTX 2080Ti GPU can build 8-ary Merk

## Implementation Specification

Filecoin's Poseidon specification is published in the Filecoin specification document [here](https://spec.filecoin.io/#section-algorithms.crypto.poseidon). Additionally, a PDF version is mirrored in this repo [here](poseidon_spec.pdf).
Filecoin's Poseidon specification is published in the Filecoin specification document [here](https://spec.filecoin.io/#section-algorithms.crypto.poseidon). Additionally, Markdown and PDF versions are mirrored in this repo in the [`spec`](spec) directory.

### Contributing to the Spec

### PDF Rendering Instructions

The spec's PDF is rendered using [Typora](https://typora.io/). Download the spec's Markdown file [here](spec/poseidon_spec.md), open the file in Typora, make and save your changes, then export the file as a PDF.

### Ensuring Spec Documents Stay in Sync

When making changes to the spec documents in `neptune`, make sure that the spec's PDF file `poseidon_spec.pdf` is the PDF rendering of the Markdown spec `poseidon_spec.md`.

If you make changes to the spec in `neptune`, you must make those same changes to the Filecoin spec [here](https://github.com/filecoin-project/specs/blob/master/content/algorithms/crypto/poseidon.md), thus ensuring all three document's (one Markdown+Latex and one PDF in `neptune` and one Markdown+MathJax in [`filecoin-project/specs`](https://github.com/filecoin-project/specs/)) stay in sync.

## Environment variables

Expand Down
Binary file removed poseidon_spec.pdf
Binary file not shown.
Loading

0 comments on commit cf8c7ad

Please sign in to comment.