Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.28 KB

README.md

File metadata and controls

50 lines (32 loc) · 1.28 KB

espicoruby

This project runs PicoRuby on ESP32 and serves as an example of using picoruby-esp32.
Currently, it has only been tested on the M5Stamp C3 Mate.

Getting Started

Preparation

Set up your development environment using ESP-IDF by referring to this page.

Setup

Run the following shell script to build PicoRuby:

$ git clone https://github.com/yuuu/espicoruby.git

Build

Build the project using the idf.py command.

$ . $(YOUR_ESP_IDF_PATH)/export.sh
$ idf.py set-target $(YOUR_ESP_TARGET) # example: idf.py set-target esp32c3
$ idf.py build

Flash and Monitor

Flash the firmware and monitor the output using the idf.py command. PicoRuby Shell will start.

$ idf.py flash
$ idf.py monitor

Supported Environment

Currently, this project is tested in the following environment only:

  • Build OS:
    • macOS
  • Device:
    • M5Stamp C3 Mate(esp32c3)

License

espicoruby is released under the MIT License.