Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

A detailed Circomlib Readme #74

Open
Darlington02 opened this issue Jul 14, 2022 · 2 comments
Open

A detailed Circomlib Readme #74

Darlington02 opened this issue Jul 14, 2022 · 2 comments

Comments

@Darlington02
Copy link

Hello,

I was thinking, would it be possible to improve the current Readme.md in the circuits folder to explain what every single component does in better details, to facilitate easier user experience for new users?
@nihaoqingtuan
Copy link

i agree

@drewjenkins
Copy link

I know it is probably not an easy task, but it would definitely be helpful. A lot of the circuits are more geared towards cryptography experts and mathematicians. More descriptive variable names, along with some docs about what each circuit is accomplishing would be extremely helpful.

The library is extremely useful, it's just a bit hard to use at the moment.

piotr-roslaniec pushed a commit to piotr-roslaniec/circomlib that referenced this issue Sep 18, 2024
@clararod9
Merge pull request iden3#74 from iden3/removing_non_determinism
b012c7e 
removing non determinism in linear constraints that cannot be removed…
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@drewjenkins @Darlington02 @nihaoqingtuan