Add initial README

This commit is contained in:
Alan Orth 2024-02-25 18:40:13 +03:00
parent 2a33c8c5bd
commit 7b485dc732
Signed by: alanorth
GPG Key ID: 0FB860CC9C45B1B9
2 changed files with 17 additions and 0 deletions

17
README.md Normal file
View File

@ -0,0 +1,17 @@
# Safari Bingo Cards
Fun proof of concept to generate random wildlife bingo cards for safaris with data from Wikipedia.
<p align="center">
<img width="600" alt="Example bingo card showing a 4x4 grid of Sub-Saharan African wildlife" src="example.jpg">
</p>
# 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)).

BIN
example.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB