Skip to content

Commit

Permalink
Update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
@treeform
treeform committed Sep 30, 2021
1 parent 296bb01 commit 5470d47
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

`nimble install benchy`

![Github Actions](https://github.com/treeform/benchy/workflows/Github%20Actions/badge.svg)

[API reference](https://nimdocs.com/treeform/benchy)

This library has no dependencies other than the Nim standard libarary.

## About

Simple benchmarking to time your code. Just put your code in a `timeIt` block. Also put result of your computation into `keep()` so that compiler does not optimize it out. Don't forgot to run with `-d:release` or better yet `-d:danger`.

```nim
Expand Down

0 comments on commit 5470d47

Please sign in to comment.