diff --git a/README.MD b/README.MD index 46ad756..bc0d059 100644 --- a/README.MD +++ b/README.MD @@ -55,6 +55,12 @@ library. I use brew: brew install python-tk ``` +Or install directly from PyPi: + +```shell +pip3 install pixoo +``` + ## Getting started Create an interface with your device as such (of course use your own local IP-address): @@ -105,6 +111,12 @@ ABCDEFGHIJKLMNOPQRSTUVWXYZ !'()+,-<=>?[]^_:;./{|}~$@% ``` +### GICKO alternative font + +Special thanks goes to [gickowtf](https://github.com/gickowtf/pixoo) who added the GICKO alternative font and also +contributed flexible spacing to display wider and narrower letters so that they do not necessarily have to be three +pixels wide. + ## Known bugs ### Previous buffer/image is still partially visible diff --git a/examples.py b/examples.py index 8e3524f..5c39079 100644 --- a/examples.py +++ b/examples.py @@ -1,13 +1,16 @@ from pixoo import Channel, ImageResampleMode, Pixoo +from pixoo.font import Font ''' Create a connection to a Pixoo -First argument is its IP address (required) +First argument is its IP address (optional) The second argument is the display size (optional, default 64) The third argument is the 'debug mode' (optional, default False), which enables logging of important actions ''' pixoo = Pixoo('192.168.50.214', 64, True) +# or +pixoo = Pixoo() # The following are all 'drawing' methods. # Afterwards, be sure to call `pixoo.push()` to send the internal buffer to the connected display @@ -56,6 +59,11 @@ # or pixoo.draw_text_at_location_rgb('Neat', 0, 6, 255, 255, 0) +''' +To use the alternative GICKO font, simply specify it: +''' +pixoo.draw_text('Hello there..', (0, 0), (0, 255, 0), Font.FONT_GICKO) + ''' Load and add an image to the buffer.