codex-storage
/
codex-storage-proofs
mirror of https://github.com/codex-storage/codex-storage-proofs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

updating readme

This commit is contained in:
Dmitriy Ryajov 2023-03-20 22:12:01 -06:00
parent f52233c731
commit 0c1b4faa58
No known key found for this signature in database
GPG Key ID: DA8C680CE7C657A4
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -18,22 +18,24 @@ or
at your option. These files may not be copied, modified, or distributed except according to those terms.
## Usage
First
```
First, clone the repo and install the circom components:
```sh
git clone git@github.com:status-im/codex-storage-proofs.git
cd codex-storage-proofs
npm i
cd circuits
```
Preparing test key material (only suitable for testing)
```
../scripts/circuit_prep.sh storer 13
Nex, compile circuits:
```sh
../scripts/circuit_prep.sh
```
Running the tests:
`npm test`
```
npm test test/merkletree.js
```sh
cargo test -r # run tests in release mode by default for speed
```