Skip to content

Commit

Permalink
documentation: extended example usages
Browse files Browse the repository at this point in the history
  • Loading branch information
Luka5W committed Sep 27, 2024
1 parent a87e3b4 commit 1533c26
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}' \
Expand All @@ -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)

Expand Down

0 comments on commit 1533c26

Please sign in to comment.