archive
/
pixoPython
mirror of https://github.com/c0de-archive/pixoPython.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Add some getting started instructions

This commit is contained in:
David Todd (c0de) 2018-09-27 20:09:46 -05:00
parent 00ca9037a6
commit 9ad6dcd1bc
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
readme.md
View File

@ -1,5 +1,12 @@
# PixoPython
This is a project that aims to serve as a general purpose API server/client that drives the 16x16 RGB LED matrix of the [pixopixel](https://github.com/IdleHandsProject/pixopixel), except implemented in [esp32 micropython](https://github.com/micropython/micropython/tree/master/ports/esp32)
This is a project that aims to serve as a general purpose API server/client that drives the 16x16 RGB LED matrix of the [pixopixel](https://github.com/IdleHandsProject/pixopixel), except implemented in [micropython](https://github.com/micropython/micropython)
## License: MIT, refer to `license` for more information
## Getting Started:
1. Set up the [esp-IDF](https://github.com/espressif/esp-idf.git) tookchain according to the instructions for [micropython](https://github.com/micropython/micropython/tree/master/ports/esp32). Ensure that you are able to get a python prompt.
2. Install Adafruit's [ampy](https://github.com/adafruit/ampy). This will be used to access the filesystem on the pixopixel.
3. `git clone https://github.com/alopexc0de/pixoPython.git`
## License:
MIT, refer to `license` for more information