Skip to content

Commit

Permalink
docs: drop benchmark section from readme
Browse files Browse the repository at this point in the history
I think it is quiet useless, because it doesn't explain what exactly is
benchmarked and how to interpret the results.
  • Loading branch information
matklad committed May 14, 2024
1 parent 5d5ec18 commit 8ca00f1
Showing 1 changed file with 0 additions and 17 deletions.
17 changes: 0 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,23 +172,6 @@ Here are a few key pages you might be interested in:
* [Subscribe to our monthly newsletter for the backstory on recent database changes.](https://mailchi.mp/8e9fa0f36056/subscribe-to-tigerbeetle)
* [Check out past and upcoming talks.](/docs/TALKS.md)

## Benchmarks

First grab the sources and run the setup script:

```console
git clone https://github.com/tigerbeetle/tigerbeetle.git
cd tigerbeetle
./scripts/install_zig.sh
./zig/zig build -Drelease -Dconfig=production
```

With TigerBeetle installed, you are ready to benchmark!

```console
./tigerbeetle benchmark
```

## Contributing

Read [docs/HACKING.md](docs/HACKING.md).
Expand Down

0 comments on commit 8ca00f1

Please sign in to comment.