mirror of
https://github.com/c0de-archive/pixoPython.git
synced 2024-12-21 13:02:40 +00:00
Add some getting started instructions
This commit is contained in:
parent
00ca9037a6
commit
9ad6dcd1bc
11
readme.md
11
readme.md
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user