/ README.md
README.md
 1  # CircomLib
 2  
 3  ## Description
 4  
 5  - This repository contains a library of circuit templates. 
 6  - All files are copyrighted under 2018 0KIMS association and part of the free software [circom](https://github.com/iden3/circom) (Zero Knowledge Circuit Compiler). 
 7  - You can read more about the circom language in [the circom documentation webpage](https://docs.circom.io/).
 8  
 9  ## Organisation
10  
11  This respository contains 5 folders:
12  - `circuits`: it contains the implementation of different cryptographic primitives in circom language.
13  - `calcpedersenbases`: set of functions in JavaScript used to find a set of points in [Baby Jubjub](https://github.com/barryWhiteHat/baby_jubjub) elliptic curve that serve as basis for the [Pedersen Hash](https://github.com/zcash/zcash/issues/2234).
14  - `doc`: it contains some circuit schemes in ASCII (must be opened with Monodraw, an ASCII art editor for Mac).
15  - `src`: it contains similar implementation of circuits in JavaScript.
16  - `test`: tests.
17  
18  A description of the specific circuit templates for the `circuit` folder will be soon updated.