Skip to content

Commit

Permalink
minor changes in doc and READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
jlmunoz77 committed Oct 11, 2021
1 parent 15d0dba commit 6a46bd6
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 12 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
`circom` is a compiler written in Rust for compiling circuits written in the `circom` language.
The compiler outputs the representation of the circuit as constraints and everything needed to compute different ZK proofs.
# ⚠ Important deprecation note

The old compiler writen in Javascript will be frozen and can still be downloaded from https://github.com/iden3/circom_old.
The old `circom` compiler written in Javascript will be frozen, but it can still be downloaded from the [old circom repository](https://github.com/iden3/circom_old).

# About circom

Current `circom` is a compiler written in Rust for compiling circuits written in the `circom` language.
The compiler outputs the representation of the circuit as constraints and produces everything needed to compute different ZK proofs. The documentation for installing and using `circom` and its associated tools can be found at [doc](https://circom.io).
27 changes: 19 additions & 8 deletions mkdocs/docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ TODO add and mini explain ffjavascript
Put links to all the docs
-->

# The circom ecosystem
# Installing the circom ecosystem

## ⚠ Important deprecation note

The old `circom` compiler written in Javascript will be frozen, but it can still be downloaded from the [old circom repository](https://github.com/iden3/circom_old).

## Installing dependencies

You need several dependencies installed in your system to
install all the tools related to `circom` circuits.
You need several dependencies in your system to
run `circom` and its associated tools.

* The core tool is the `circom` compiler which is written in Rust.
To have Rust available in your system, you can install `rustup`. If you’re using Linux or macOS, open a terminal and enter the following command:
Expand All @@ -35,7 +39,7 @@ The compiler outputs the representation of the circuit as constraints and everyt
To install from our sources, clone the `circom` repository:

```text
git clone https://github.com/hermeGarcia/circom_compiler.git
git clone https://github.com/iden3/circom.git
```

Enter the directory circom_compiler and use the cargo build to compile `circom`:
Expand All @@ -60,7 +64,7 @@ Now, you should be able to see all the options of the executable by using the `h
```console
circom --help

Circom Compiler 2.0
Circom Compiler 2.0.0
IDEN3
Compiler for the Circom programming language

Expand Down Expand Up @@ -92,10 +96,17 @@ circom --help

With `circom`, it is possible to create large circuits by combining smaller generic circuits called `templates`. The `circomlib` is a library of `circom` templates that contains hundreds of circuits such as comparators, hash functions, digital signatures, binary and decimal convertors and many more. You can also create your custom templates, but before start coding, we recommend you to take a look at our already created templates.

To install `circomlib`, clone its github repository:
You can install `circomlib` either as an npm package or by cloning its repository.
To install `circomlib` as a npm package:

```text
git clone [email protected]:alrubio/circomlib2.git
npm install circomlib -g
```

If you want to clone its repository:

```text
git clone https://github.com/iden3/circomlib.git
```
The package already contains tests for circuits available in the `circomlib`.
The package also installs the npm packages `circomlibjs` and `circom_tester` as dependencies.
Expand Down Expand Up @@ -137,4 +148,4 @@ You can install `snarkjs` with the following command:

```text
npm install -g snarkjs
```
```
6 changes: 5 additions & 1 deletion mkdocs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# About the circom ecosystem

Circom and its ecosystem of tools allow you to create, test and create zero knowledge proofs for your circuits.
The circom compiler and its ecosystem of tools allows you to create, test and create zero knowledge proofs for your circuits.

# ⚠ Important deprecation note

Current `circom` is a compiler written in Rust. The old `circom` compiler written in Javascript will be frozen, but it can still be downloaded from the [old circom repository](https://github.com/iden3/circom_old).

# Visual summary <a id="visual-summary"></a>

Expand Down

0 comments on commit 6a46bd6

Please sign in to comment.