From 9ad6dcd1bcbcd7d216cdf7e510340a1a119b3ea3 Mon Sep 17 00:00:00 2001 From: "David Todd (c0de)" Date: Thu, 27 Sep 2018 20:09:46 -0500 Subject: [PATCH] Add some getting started instructions --- readme.md | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/readme.md b/readme.md index 8c92f66..fec0bea 100644 --- a/readme.md +++ b/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