Skip to content

Commit

Permalink
Update README.md to reflect #3
Browse files Browse the repository at this point in the history
  • Loading branch information
czlee authored Oct 2, 2021
1 parent 848d158 commit 4a4692f
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,13 @@ Then, to submit your file for inclusion in this repository:
3. Submit a **pull request** from your fork to this repository.

### Note on formats.json
The `update_list.py` script updates the formats.json file. At some point, it should be run, and the result committed to the repository to update the list that Debatekeeper first downloads. If you can run this script as part of your PR, that's great, but don't worry about it—I can do it easily after merging your PR. Currently, until the new Debatekeeper release finishes beta testing, formats.json includes a couple of "bad" entries to allow testing of error conditions in the app, so to include those:
A GitHub Action automatically runs after every commit to update the formats.json file (thanks to [Frank Richter](https://github.com/res2k) in [#3](https://github.com/czlee/debatekeeper-formats/pull/3)!), so you shouldn't need to do this. However, you can run the `update_list.py` script locally to see what it'll do if you like.

Currently, until the Debatekeeper version 1.3 finishes beta testing, formats.json includes a couple of "bad" entries to allow testing of error conditions in the app, so to include those:
```
python update_list.py --add-errors
```

(In an ideal world, formats.json would be generated by the site build, but as far as I'm aware, custom plugins [can't be used with GitHub Pages](https://jekyllrb.com/docs/plugins/installation/).)

How this is hosted
------------------

Expand Down

0 comments on commit 4a4692f

Please sign in to comment.