From 254ba2bb55abfe537098feb8e17196b9966ceb8e Mon Sep 17 00:00:00 2001 From: yaleman Date: Mon, 12 Aug 2019 12:26:05 +1000 Subject: [PATCH] Updated readme to include flash instructions --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 1cc43c36..82bdc755 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,19 @@ # M5Stack Micropython Base [Lobo MicroPython](https://github.com/loboris/MicroPython_ESP32_psRAM_LoBo/) -## Getting Start +## Getting Started - See LoBo MicroPython [WiKi](https://github.com/loboris/MicroPython_ESP32_psRAM_LoBo/wiki) - Please make sure run ```./BUILD.sh menuconfig``` choose open **MicroPython --> Modules --> Use Display module** +### Simple Build instructions + +This works for Linux or macOS, windows is slightly different. Follow the information above to prepare your build environment. + +1. Clone the repository `git clone https://github.com/m5stack/M5Stack_MicroPython` +2. Enter the build `cd M5Stack_MicroPython/MicroPython_BUILD/` +3. Build the firmware `./BUILD.sh` +4. Flash the firmware `./BUILD.sh flash` + ## Upload code - Use [Ampy](https://github.com/adafruit/ampy) - Use [Lobo Miropython filesystems](https://github.com/loboris/MicroPython_ESP32_psRAM_LoBo/wiki/filesystems)