Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
martinus committed Oct 12, 2019
1 parent 6a63f9a commit 7c0ad65
Showing 1 changed file with 10 additions and 3 deletions.
13 changes: 10 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,22 @@

Simple, fast, accurate microbenchmarking functionality for C++11/14/17/20.

**ankerl::nanobench** is:
* Easy to integrate - single header.
* Easy to use: Automatic configuration
* Fast: runtime is based based on the clock's accuracy
* Accurate: overhead for measurements is kept as small as possible
* Robust: Multiple evaluations (epochs) give robust statistics which protects against outliers. Warns when System
not prepared for benchmarking (turbo mode, frequency scaling, debug mode, ...)
* Fast to compile

# Features

* Single header library: you only need `nanobench.h`. Nothing else.
* Easily integratable in any unit test framework: Pure C++. no Macros, no runners, no global registrations
* Zero configuration: Automatically detects number of iterations for accurate measurements.
* Fast execution: runtime is based on the clock's accuracy
* Warns when system is not configured for benchmarking (currently only in Linux)
* Warns at unstable results - with suggestions
* Output in Markdown table format

# Examples

## Simple Example
Expand Down

0 comments on commit 7c0ad65

Please sign in to comment.