From 6964d9550697170a352a64ba58ce515d86eb2a9e Mon Sep 17 00:00:00 2001
From: Lars Wirzenius <liw@liw.fi>
Date: Mon, 15 Apr 2024 09:08:47 +0300
Subject: docs: update README

---
 README | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/README b/README
index 7fec37b..7d7af93 100644
--- a/README
+++ b/README
@@ -1,2 +1,19 @@
 This git repo contains one or more benchmark specifications for use
 with obbench, the Obnam benchmarking tool.
+
+Notes for Lars to run these benchmarks, against a specific version,
+specified using a git tag name, branch name, or commit id (below,
+`ID`):
+
+* Sync the `obnam-benchmark-specs` repository (this one) to the
+  `obnam-bench` VM, the `~/src` directory.
+* In the `obnam-bench` VM, as `liw`:
+  - `cd ~/src`
+  - `obnam-benchmark run --auto --obnam ID benchmarks.yaml`
+    - replace `ID` with the version you want to use
+* Copy the resulting JSON file to the `obnam-benchmark-results`
+  repository.
+  - ` scp "obnam-bench:src/*.json" .`
+* Build report locally and review it.
+  - `./report.sh *.json`
+  <https://doc.obnam.org/obnam-benchmark-results/>.
-- 
cgit v1.2.1