Skip to content

Commit

Permalink
Merge pull request #3 from Modulo-P/develop
Browse files Browse the repository at this point in the history
updated readme
  • Loading branch information
ajuggler authored Feb 16, 2024
2 parents f810911 + 1cbf2c6 commit a01fcfd
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
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).

0 comments on commit a01fcfd

Please sign in to comment.