aiken/examples/benchmarks/README.md

56 lines
800 B
Markdown

# benchmarks
Write validators in the `validators` folder, and supporting functions in the `lib` folder using `.ak` as a file extension.
For example, as `validators/always_true.ak`
```gleam
validator {
fn spend(_datum: Data, _redeemer: Data, _context: Data) -> Bool {
True
}
}
```
## Building
```sh
aiken build
```
## Testing
You can write tests in any module using the `test` keyword. For example:
```gleam
test foo() {
1 + 1 == 2
}
```
To run all tests, simply do:
```sh
aiken check
```
To run only tests matching the string `foo`, do:
```sh
aiken check -m foo
```
## Documentation
If you're writing a library, you might want to generate an HTML documentation for it.
Use:
```sh
aiken docs
```
## Resources
Find more on the [Aiken's user manual](https://aiken-lang.org).