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

updated readme #3

Merged
merged 1 commit into from
Feb 16, 2024
Merged

updated readme #3

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
# ak-381
# ZK-verification code written in Aiken

We implement the ZK-verification code tailored to *snarkjs* output, using Aiken's **bls12_381** built-in primitives.

# Standard Aiken Documentation

## ak-381

Write validators in the `validators` folder, and supporting functions in the `lib` folder using `.ak` as a file extension.

Expand All @@ -12,13 +18,13 @@ validator {
}
```

## Building
### Building

```sh
aiken build
```

## Testing
### Testing

You can write tests in any module using the `test` keyword. For example:

Expand All @@ -40,7 +46,7 @@ To run only tests matching the string `foo`, do:
aiken check -m foo
```

## Documentation
### Documentation

If you're writing a library, you might want to generate an HTML documentation for it.

Expand All @@ -50,6 +56,6 @@ Use:
aiken docs
```

## Resources
### Resources

Find more on the [Aiken's user manual](https://aiken-lang.org).
Loading