Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
15 changes: 9 additions & 6 deletions docs/benchx.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,15 @@ implement a missing feature.
- A collection of worked examples: <https://github.com/benchx-dev/benchx_examples>


# Install

Install from [PyPI](https://pypi.org/project/benchx/):

```console
$ pip install benchx
```


# CLI API

At a glance:
Expand Down Expand Up @@ -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
Expand Down
Loading