Skip to content

Commit

Permalink
Merge pull request #1314 from googlefonts/fixup-crater-readme
Browse files Browse the repository at this point in the history
[crater] Fixup readme to use targets.json
  • Loading branch information
rsheeter authored Feb 28, 2025
2 parents e66c51a + 792bd4d commit 08ae216
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions fontc_crater/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To run in CI mode locally to play with the html output:
When run in CI, we want to ensure that we have complete control over the set of
python pacakges we are comparing against; to ensure this we use `pip-compile`
(part of [`pip-tools`]) to generate a pinned `requirements.txt` from a
`requirements.in` file in the root `resources/scripts` directory.
`requirements.in` file in the root `resources/scripts` directory.

To update the set of python packages in use, you need to update this file:

Expand All @@ -45,7 +45,7 @@ To run locally to rebuild the HTML:
# clone git@github.com:googlefonts/fontc_crater.git somewhere, we'll assume at ../fontc_crater
# CI currently has it's own format for the repo list, use the file from ^

$ cargo run --release -p=fontc_crater -- ci ../fontc_crater/gf-repos-2024-09-23.json -o ../fontc_crater/results/ --html-only
$ cargo run --release -p=fontc_crater -- ci ../fontc_crater/targets.json -o ../fontc_crater/results/ --html-only

# Review ../fontc_crater/results/index.html (NOT ../fontc_crater/index.html)
```
Expand All @@ -58,7 +58,7 @@ checkout as above):
# cd ../fontc_crater && git pull

$ RUST_LOG=debug cargo run --release -p fontc_crater \
-- ci ../fontc_crater/gf-repos-2025-02-19.json --out ../fontc_crater/results/
-- ci ../fontc_crater/targets.json --out ../fontc_crater/results/

```

Expand Down

0 comments on commit 08ae216

Please sign in to comment.