diff --git a/README.md b/README.md new file mode 100644 index 0000000..c4bca4e --- /dev/null +++ b/README.md @@ -0,0 +1,17 @@ +# Safari Bingo Cards +Fun proof of concept to generate random wildlife bingo cards for safaris with data from Wikipedia. + +

+ Example bingo card showing a 4x4 grid of Sub-Saharan African wildlife +

+ +# Usage + +```console +$ ./generate.py -i data/animals.csv -o out.jpg +``` + +# License +This work is licensed under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html). + +The license allows you to use and modify the work for personal and commercial purposes, but if you distribute the work you must provide users with a means to access the source code for the version you are distributing. Read more about the [GPLv3 at TL;DR Legal](https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)). diff --git a/example.jpg b/example.jpg new file mode 100644 index 0000000..8412a55 Binary files /dev/null and b/example.jpg differ