Skip to content

Commit

Permalink
fix readme link, describe how it works
Browse files Browse the repository at this point in the history
  • Loading branch information
sckott committed Mar 19, 2024
1 parent 371831c commit 72f5e7c
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://getwilds.org/registry/registry.json>

0 comments on commit 72f5e7c

Please sign in to comment.