From ecd9db48494f4413a7dd22ff457c528cd201eadf Mon Sep 17 00:00:00 2001 From: Rok Mihevc Date: Fri, 6 Nov 2026 19:37:36 +0100 Subject: [PATCH] DOC: link to PyPI and show the install command earlier --- README.md | 2 ++ docs/benchx.md | 15 +++++++++------ 2 files changed, 11 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e7fd602..8b35acc 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ allow all of them. ## BenchX usage and development +Install with `pip install benchx` ([PyPI](https://pypi.org/project/benchx/)). + We welcome contributions of all sorts: add a user story, tell us about your use case, try `benchx` on your workflow/project, open an issue if you found a rough edge, implement a missing feature. diff --git a/docs/benchx.md b/docs/benchx.md index 45c62c2..d0897f7 100644 --- a/docs/benchx.md +++ b/docs/benchx.md @@ -19,6 +19,15 @@ implement a missing feature. - A collection of worked examples: +# Install + +Install from [PyPI](https://pypi.org/project/benchx/): + +```console +$ pip install benchx +``` + + # CLI API At a glance: @@ -214,12 +223,6 @@ every result is pyperf. Results also record the installed project's version store: the ad hoc path. Condition measurements (`measurement.kind: condition`) are not compared, and deterministic quantities are deferred. -## Install - -```console -$ pip install benchx -``` - ## Run it ```console