aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFuwn <[email protected]>2021-06-07 03:01:20 -0700
committerFuwn <[email protected]>2021-06-07 03:01:20 -0700
commitfabdb4e54139ada0a4abc044a2406ccd72237cba (patch)
treead56b5ac620e9ae0ae5a5f39582ff5352b7848e6
parentfix(nix): add valgrind (dep of iai) to build inputs (diff)
downloadwhirl-fabdb4e54139ada0a4abc044a2406ccd72237cba.tar.xz
whirl-fabdb4e54139ada0a4abc044a2406ccd72237cba.zip
docs(readme): benchmark notes
-rw-r--r--README.rst21
1 files changed, 20 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 9cbe859..ec6328a 100644
--- a/README.rst
+++ b/README.rst
@@ -90,10 +90,29 @@ Optional
- `cargo-watch <https://crates.io/crates/cargo-watch>`_
- `sqlfluff <https://github.com/sqlfluff/sqlfluff>`_
+- `Valgrind <https://www.valgrind.org/>`_
-*These development dependencies (exlcluding sqlfluff) will automatically be satisfied if you are using the Nix shell
+*These development dependencies (excluding sqlfluff) will automatically be satisfied if you are using the Nix shell
configuration as provided.*
+Benchmarking
+------------
+
+For the time being; benchmarking is only available for *nix-based environments as the benchmarking
+utility currently in place, `Iai <https://github.com/bheisler/iai>`_, has a hard dependency on
+`Valgrind <https://github.com/bheisler/iai>`_ which is only accessible within *nix-based
+environments.
+
+More so, the current benchmarks which have been set-up do not cover the full extent of Whirl, but a
+small portion of the crates which make up Whirl as a whole. In the future, benchmarks may be
+expanded upon.
+
+To execute the available benchmarks, use the following Cargo subcommand;
+
+.. code-block:: shell
+
+ $ cargo bench
+
License
~~~~~~~