From 4465c08c786b30eb2f7bde2f8d457fcd58505ab4 Mon Sep 17 00:00:00 2001 From: Alan Orth Date: Mon, 26 Feb 2024 09:24:36 +0300 Subject: [PATCH] README.md: add requirements --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 1947b21..ffc49f7 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,21 @@ Fun proof of concept to generate random wildlife bingo cards for safaris with da

# Usage +Once the requirements are satisfied you can generate a card. By default it generates a 4x4 grid with 16 images: ```console $ ./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 - Credit photographers — these photos are all some variation of CC-BY so we need to give attribution