diff --git a/README.md b/README.md index f7d45df..36b27b2 100644 --- a/README.md +++ b/README.md @@ -259,4 +259,39 @@ What? Why would you wanna cite it? What are you even doing? url = {https://git.dominik-roth.eu/dodox/NuCon}, year = {2024}, } +``` + +--- + +![NuCon Meme](README_meme.jpg) + +To use you'll need to install the following packages: + +```bash +pip install pillow +``` + +### Usage: + +```python +from nucon.drake import create_drake_meme + +items = [ + (False, "Play Nucleares manually"), + (True, "Automate it with a script"), + (False, "But the web interface is tedious to use"), + (True, "Write an elegant libary to interface with the game and then use that to write the script"), + (False, "But I would still need to write the control policy by hand"), + (True, "Let's extend the libary such that it trains a policy via Reinforcement Learning"), + (False, "But RL is takes a huge number of training samples"), + (True, "Extend the libary to also include an efficient simulator"), + (False, "But I don't know what the actual internal dynamics are"), + (True, "Extend the libary once more to also include a neural network dynamics model"), + (True, "And I'm gonna put a drake meme on the README"), + (False, "Online meme generators only support a single yes/no pair"), + (True, "Let's also add a drake meme generator to the libary"), + ] + +meme = create_drake_meme(items) +meme.save("README_meme.jpg") ``` \ No newline at end of file diff --git a/README_meme.jpg b/README_meme.jpg new file mode 100644 index 0000000..1593545 Binary files /dev/null and b/README_meme.jpg differ