README.md: add requirements

This commit is contained in:
Alan Orth 2024-02-26 09:24:36 +03:00
parent 267ade7677
commit 4465c08c78
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9

View File

@ -6,11 +6,21 @@ Fun proof of concept to generate random wildlife bingo cards for safaris with da
</p> </p>
# Usage # Usage
Once the requirements are satisfied you can generate a card. By default it generates a 4x4 grid with 16 images:
```console ```console
$ ./generate.py -i data/animals.csv -o out.jpg $ ./generate.py -i data/animals.csv -o out.jpg
``` ```
# Requirements
Set up a Python 3.11+ virtual environment and install the requirements:
```console
$ python3 -m .venv
$ source .venv/bin/activate
$ pip install -r requirements.lock
```
# TODO # TODO
- Credit photographers — these photos are all some variation of CC-BY so we need to give attribution - Credit photographers — these photos are all some variation of CC-BY so we need to give attribution