From 72f5e7cebe79f079d07afd40ccb803fa386b407f Mon Sep 17 00:00:00 2001 From: Scott Chamberlain Date: Mon, 18 Mar 2024 22:10:47 -0700 Subject: [PATCH] fix readme link, describe how it works --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d0dbe04..5e23d8f 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,18 @@ WILDS Registry Registry of WILDS repositories. -The registry is in: [registry.json][] +The registry is in: [registry.json][registry.json] + +How it works locally for testing purposes: + +``` +pip install -r requirements.txt +python code.py +``` + +How it works on GitHub Actions via the `.github/workflows/build.yml` file: + +- Install Python +- Install python libraries +- Run `python code.py` +- Commit changed `registry.json` file to the default branch (`gh-pages`). This updated file is then available at