Update readme with simpler Hello World #45
Conversation
README.rst
Outdated
|
|
||
| # Scroll it | ||
| matrixportal.scroll_text(SCROLL_DELAY) | ||
|
|
There was a problem hiding this comment.
I think maybe it wants an extra newline here at the end of the code snippet.
So it will be like this:
# ...
matrixportal.scroll_text(SCROLL_DELAY)
Contributing
============
Thanks for working on this!
I had some extra whitespace at the end of my code. Thanks GH actions for catching that!
There was a problem hiding this comment.
I tested this out on a Matrix Portal and it's working well.
I found a few small things that I think we can clean up a bit. This looks good to me beyond these.
I think it would be good eventually to rename the existing simpletest to something like bitcoin_example and then make this version from the readme be the same as simpletest in the examples folder. That can get done in a follow up after this though.
README.rst
Outdated
| @@ -37,55 +37,44 @@ Usage Example | |||
| .. code:: python | |||
|
|
|||
| import time | |||
| import random | |||
There was a problem hiding this comment.
I think we can get rid of this import random
There was a problem hiding this comment.
Good catch. Thanks. Will remove.
README.rst
Outdated
| ) | ||
|
|
||
| # Static 'Connecting' Text |
There was a problem hiding this comment.
Since we don't have 'connecting' text anymore I think we can remove this comment.
There was a problem hiding this comment.
Doh! Will remove
README.rst
Outdated
| { 'text': 'THIS IS BLUE', 'color': '#0846e4'}, | ||
| ] | ||
|
|
||
| matrixportal.set_text(" ", 1) |
There was a problem hiding this comment.
We might be able to remove this line? I'm not sure if it's needed. The script seems to behave the same without it.
There was a problem hiding this comment.
Will do. Copy/paste from previous examples.
| DATA_SOURCE = "https://api.coindesk.com/v1/bpi/currentprice.json" | ||
| DATA_LOCATION = ["bpi", CURRENCY, "rate_float"] | ||
| # --- Display setup --- | ||
| matrixportal = MatrixPortal(status_neopixel=board.NEOPIXEL, debug=True) |
There was a problem hiding this comment.
Could you remove the debug=True? It was intended for debugging. ;) It was accidentally left in the current code.
There was a problem hiding this comment.
As a new user, the debug=True was valuable. I understand it's a left-over artifact, and it's one that I'm glad was there when I got started. If you feel strongly about it, I'll remove it.
There was a problem hiding this comment.
Interesting, I didn't realize it was so helpful. I suppose we can leave it if you like.
Updating https://github.com/adafruit/Adafruit_CircuitPython_MatrixPortal to 1.9.3 from 1.9.1: > Merge pull request adafruit/Adafruit_CircuitPython_MatrixPortal#45 from lastcoolnameleft/patch-1
As per #41