Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
altergui committed Nov 14, 2023
1 parent ac9fa43 commit 17a89fa
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 100 deletions.
6 changes: 3 additions & 3 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ RUN apt update \

COPY ./scripts/* /bin/

CMD [ "/bin/bash" ]
CMD [ "/bin/contribute-ceremony.sh" ]

### image to create ceremonies
FROM node AS zk-voceremony-creator
FROM node AS zk-voceremony-create

WORKDIR /app

Expand All @@ -45,4 +45,4 @@ RUN mkdir -p /temp && cd /temp && \

COPY ./scripts/* /bin/

CMD [ "/bin/scripts/create-ceremony.sh" ]
CMD [ "/bin/create-ceremony.sh" ]
89 changes: 0 additions & 89 deletions Makefile

This file was deleted.

18 changes: 10 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,11 @@ You can read more about trusted zk ceremonies [here](https://zkproof.org/2021/06

### Contribute to a ceremony

**A.** Clone the repository and checkout the branch with the name of the desired ceremony:
**A.** You just need docker run, the image will clone this repository and guide you through the whole process
```sh
git clone [email protected]:vocdoni/zk-voceremony.git
git checkout {CEREMONY_BRANCH}
docker run --rm -it zk-voceremony
```

**B.** Init the contribution and follow the instructions:
```sh
make contribute
```
This will create:
* `{CONTRIBUTIONS_PATH}/{circuite_name}_{contributor_alias}.zkey`: The result of your contribution.

Expand All @@ -52,7 +47,7 @@ And will update:
### Create a new zk-ceremony
**A.** Run the following command to prepare the environment:
```sh
make env
docker run --rm -it zk-voceremony
```
This will create the `ceremony.env` following the `example.env` template, asking to you the required inputs. Then it will copy from your filesystem into the repo:
* `{INPUTS_PATH}/{circuite_name}.circom`: the circom circuit file target of the ceremony
Expand All @@ -62,3 +57,10 @@ It also will create the ceremony branch, commit and push these files to this bra

A Github action will compile the circuit and generate the first contribution in the `{ceremony_name}` branch. This Github will also create an Pull Request assigned to you. If this PR is closed by you (without merge it), another Github action will be triggered that will finish the ceremony and generate the final artifacts.


### Build

```
docker build . --target zk-voceremony -t zk-voceremony
docker build . --target zk-voceremony-create -t zk-voceremony-create
```

0 comments on commit 17a89fa

Please sign in to comment.