From 1533c26a4d39ef62a7979628af300295197cb210 Mon Sep 17 00:00:00 2001 From: Luka5W <74739057+Luka5W@users.noreply.github.com> Date: Fri, 27 Sep 2024 18:33:13 +0000 Subject: [PATCH] documentation: extended example usages --- README.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c392140..a6ff6a0 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,12 @@ Requirements 2. python3 (with PIL) 3. Any good operating system (this - of course - excludes Micro$oft Windows; might work but untested) -Usage ------ +Example Usage +------------- + +### Generate Image + +_for a 1.54" tag_ ```bash ./eink_create_img.py -i '{"t":"Hello","f":"/usr/share/fonts/truetype/freefont/FreeMono.ttf","s":16,"c":1,"x":0,"y":0,"a":0}' \ @@ -22,7 +26,21 @@ Usage -vv ``` -produces this image: +### Generate and Upload Image + +_for a 2.9" tag, in **w**ide (not **t**all) orientation_ + +```bash +./eink_create_img.py -i '{"t":"Hello","f":"/usr/share/fonts/truetype/freefont/FreeMono.ttf","s":16,"c":1,"x":0,"y":0,"a":0}' \ + '{"t":"World","f":"/usr/share/fonts/truetype/freefont/FreeMono.ttf","s":16,"c":2,"x":0,"y":20,"a":0}' \ + -o helloworld.jpg \ + -r 0 \ + -s 2.9w \ + -vv \ + -u 'http://192.168.178.192' '00000197E5CB3B38' # the first four '0' can be ommitted +``` + +Produced Image: ![A generated image showing Hello in black and World in red on a white background](./helloworld.jpg)