diff options
Diffstat (limited to 'backend/hist_data/picked')
| -rw-r--r-- | backend/hist_data/picked/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/backend/hist_data/picked/README.md b/backend/hist_data/picked/README.md new file mode 100644 index 0000000..becbd24 --- /dev/null +++ b/backend/hist_data/picked/README.md @@ -0,0 +1,29 @@ +This directory holds data for additional events + +Files +===== +- events.json <br> + Encodes an array of objects, each describing an event to add. + For example: + + [{ + "title": "COVID-19 Pandemic", + "start": 2458919, + "start_upper": null, + "end": null, + "end_upper": null, + "fmt": 2, + "ctg": "event", + "image": { + "file": "covid.jpg", + "url": "https://en.wikipedia.org/wiki/File:Covid-19_SP_-_UTI_V._Nova_Cachoeirinha.jpg", + "license": "cc-by-sa 4.0", + "artist": "Gustavo Basso", + "credit": "" + }, + "desc": "Global pandemic caused by the virus SARS-CoV-2", + "pop": 100 + }] + + The `image.file` field should name an image file in this directory. + Other fields correspond to those in the `events`, `images`, `descs`, and `pop` tables (see `../README.md`). |
