From b818695ba6a9d2ca44bf124da06c453ba6596c37 Mon Sep 17 00:00:00 2001 From: Philip Chmielowiec <67855069+philipc2@users.noreply.github.com> Date: Thu, 15 Aug 2024 15:14:38 -0500 Subject: [PATCH] Update README.md --- README.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 281e3d3d..5338d8ad 100644 --- a/README.md +++ b/README.md @@ -5,18 +5,16 @@ Air Speed Velocity (ASV) benchmarking for the UXarray Python Package ## Quickstart - -UXarray's benchmark suite is written using the airspeed velocity package, which can be installed as follows: - -Step 1 +UXarray's benchmarks are stored in the package repository (not in this one), which should first be cloned. ``` git clone https://github.com/UXARRAY/uxarray.git ``` -Step 2 + +The benchmarks and configuration files are located in the `benchmarks` directory. ``` cd benchmarks ``` -Step 3 +Asv needs to be installed locally in order to run any benchmarks. ``` pip install asv ```