Skip to content

Commit fa412bf

Browse files
authored
Merge pull request #12 from brianckeegan/claude/add-doc-example-images-MGAd3
Fix README images: use distinct text for each example section
2 parents 5dff198 + 512adee commit fa412bf

7 files changed

Lines changed: 25 additions & 13 deletions

File tree

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,20 +72,20 @@ memes.meme("/path/to/image.jpg", "top text", "bottom text")
7272
from memeplotlib import Meme
7373

7474
# Step by step
75-
m = Meme("buzz")
76-
m.top("memes")
77-
m.bottom("memes everywhere")
75+
m = Meme("drake")
76+
m.top("reading docs")
77+
m.bottom("guessing until it works")
7878
m.save("output.png")
7979
```
8080

81-
![buzz OO example](docs/_static/examples/readme_buzz_oo.png)
81+
![drake OO example](docs/_static/examples/readme_drake_oo.png)
8282

8383
```python
8484
# Or chained
85-
Meme("doge").top("such code").bottom("very bug").show()
85+
Meme("buzz").top("python").bottom("python everywhere").show()
8686
```
8787

88-
![doge OO example](docs/_static/examples/readme_doge_oo.png)
88+
![buzz OO chained example](docs/_static/examples/readme_buzz_oo_chained.png)
8989

9090
### Memify Existing Plots
9191

@@ -110,8 +110,12 @@ import memeplotlib as memes
110110
memes.config.font = "comic"
111111
memes.config.color = "yellow"
112112
memes.config.style = "none" # don't auto-uppercase
113+
114+
memes.meme("buzz", "custom defaults", "applied everywhere", show=False)
113115
```
114116

117+
![global configuration example](docs/_static/examples/readme_config.png)
118+
115119
### Template Discovery
116120

117121
```python
-742 KB
Binary file not shown.
742 KB
Loading
753 KB
Loading
-871 KB
Binary file not shown.
1.44 MB
Loading

docs/generate_examples.py

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -221,15 +221,23 @@ def generate_readme_images() -> None:
221221
)
222222
_save(fig, "readme_distracted_functional")
223223

224-
# OO API – buzz
224+
# OO API – drake step-by-step
225+
tmpl = _get_template("drake")
226+
fig, _ = render_meme(tmpl, ["reading docs", "guessing until it works"])
227+
_save(fig, "readme_drake_oo")
228+
229+
# OO API – buzz chained
225230
tmpl = _get_template("buzz")
226-
fig, _ = render_meme(tmpl, ["memes", "memes everywhere"])
227-
_save(fig, "readme_buzz_oo")
231+
fig, _ = render_meme(tmpl, ["python", "python everywhere"])
232+
_save(fig, "readme_buzz_oo_chained")
228233

229-
# OO API – doge chained
230-
tmpl = _get_template("doge")
231-
fig, _ = render_meme(tmpl, ["such code", "very bug"])
232-
_save(fig, "readme_doge_oo")
234+
# Global Configuration
235+
tmpl = _get_template("buzz")
236+
fig, _ = render_meme(
237+
tmpl, ["custom defaults", "applied everywhere"],
238+
font="comic", color="yellow", style="none",
239+
)
240+
_save(fig, "readme_config")
233241

234242
# Memify existing plot
235243
fig, ax = plt.subplots()

0 commit comments

Comments
 (0)