diff --git a/fontc_crater/README.md b/fontc_crater/README.md index ed45a60e..99e583c5 100644 --- a/fontc_crater/README.md +++ b/fontc_crater/README.md @@ -39,6 +39,8 @@ $ rm -f resources/scripts/requirements.txt && pip-compile resources/scripts/requ # Commit updated file ``` +To run locally to rebuild the HTML: + ```shell # 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 ^ @@ -48,6 +50,18 @@ $ cargo run --release -p=fontc_crater -- ci ../fontc_crater/gf-repos-2024-09-23. # Review ../fontc_crater/results/index.html (NOT ../fontc_crater/index.html) ``` +To do a full run locally, such as to test a PR (assuming same fontc_crater +checkout as above): + +```shell +# make sure the repo is up to date, so you're comparing against the latest run: +# 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/ + +``` + [google-fonts-sources]: https://github.com/googlefonts/google-fonts-sources [google/fonts]: https://github.com/google/fonts [rust-lang/crater]: https://github.com/rust-lang/crater