From af85e6171a5ceb1260165efcb3bb02420b11ede4 Mon Sep 17 00:00:00 2001 From: Alex Keizer Date: Thu, 15 Feb 2024 13:34:39 +0000 Subject: [PATCH] doc: clarify in the README that you need to build your project checkouts before diffing --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e11c567..fd6e79f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,8 @@ and it is at least fast enough to run on the scale of `mathlib`. Usage ----- -The main entrypoint is the script `runleaff.sh` to use it you should check out two copies of your project, one for the old version of the library and one for the new (e.g. with `git worktree add ../old/ some-other-branch`) then navigate to the Leaff directory and run +The main entrypoint is the script `runleaff.sh` to use it you should check out two copies of your project, one for the old version of the library and one for the new (e.g. with `git worktree add ../old/ some-other-branch`), +build both by running `lake build` in the corresponding directories, then navigate to the Leaff directory and run ``` ./runleaff.sh ModuleName /path/to/old-version/ /path/to/new-version/ ```