Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
kongo09 committed Jan 1, 2024
1 parent 5841056 commit 189f27f
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 1 deletion.
12 changes: 12 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -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):
Expand Down Expand Up @@ -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
Expand Down
10 changes: 9 additions & 1 deletion examples.py
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 189f27f

Please sign in to comment.