Skip to content

Commit

Permalink
doc: clarify in the README that you need to build your project checko…
Browse files Browse the repository at this point in the history
…uts before diffing
  • Loading branch information
alexkeizer committed Feb 15, 2024
1 parent 1b82190 commit af85e61
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
```
Expand Down

0 comments on commit af85e61

Please sign in to comment.