{"id":23383227,"url":"https://github.com/yuuu/picoruby-esp32","last_synced_at":"2025-10-29T09:30:28.651Z","repository":{"id":268948334,"uuid":"896606650","full_name":"yuuu/picoruby-esp32","owner":"yuuu","description":"This is a component that can be used with ESP-IDF, allowing you to add PicoRuby to your project.","archived":false,"fork":false,"pushed_at":"2025-01-28T21:13:27.000Z","size":27,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-28T22:23:23.997Z","etag":null,"topics":["esp-idf-component","esp32","picoruby","ruby"],"latest_commit_sha":null,"homepage":"","language":"CMake","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yuuu.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-30T20:15:09.000Z","updated_at":"2025-01-28T21:13:31.000Z","dependencies_parsed_at":"2025-01-09T21:26:53.673Z","dependency_job_id":"cdc24723-8bb0-4124-b3a0-ca18851bd0b8","html_url":"https://github.com/yuuu/picoruby-esp32","commit_stats":null,"previous_names":["yuuu/picoruby-esp32"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuu%2Fpicoruby-esp32","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuu%2Fpicoruby-esp32/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuu%2Fpicoruby-esp32/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuuu%2Fpicoruby-esp32/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuuu","download_url":"https://codeload.github.com/yuuu/picoruby-esp32/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238795454,"owners_count":19531745,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["esp-idf-component","esp32","picoruby","ruby"],"created_at":"2024-12-21T22:19:04.570Z","updated_at":"2025-10-29T09:30:23.164Z","avatar_url":"https://github.com/yuuu.png","language":"CMake","funding_links":[],"categories":[],"sub_categories":[],"readme":"# PicoRuby on ESP32\n\nThis is a component that can be used with ESP-IDF, allowing you to add [PicoRuby](https://github.com/picoruby/picoruby) to your project.\n\n## Getting Started\n\n### Preparation\n\nPrepare your project by referring to [this page](https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/index.html#).\n\n### Installation\n\nClone this repository into the `components` directory of your project using Git Submodule.\n\n```sh\n$ git submodule add https://github.com/yuuu/picoruby-esp32.git components/picoruby-esp32\n```\n\n### Setup\n\nRun the following shell script to build PicoRuby:\n\n```sh\n$ ./components/picoruby-esp32/install.sh\n```\n\nOpen your `main/CMakeLists.txt` file in an editor. Add `picoruby-esp32` to the `REQUIRES` field.\n\n```cmake\nidf_component_register(\n  SRCS \"main.c\"\n  REQUIRES picoruby-esp32 # \u003c-- add\n  PRIV_REQUIRES spi_flash\n  INCLUDE_DIRS \"\"\n)\n```\n\nCall `picoruby_esp32()` from your C source code.\n\n```c\n#include \"picoruby-esp32.h\"\n\nvoid app_main(void)\n{\n  picoruby_esp32();\n}\n```\n\n### Build\n\nBuild the project using the `idf.py` command.\n\n```sh\n$ . $(YOUR_ESP_IDF_PATH)/export.sh\n$ idf.py set-target $(YOUR_ESP_TARGET) # example: idf.py set-target esp32c3\n$ idf.py build\n```\n\n### Flash and Monitor\n\nFlash the firmware and monitor the output using the `idf.py` command. PicoRuby Shell will start.\n\n```sh\n$ idf.py flash\n$ idf.py monitor\n```\n\n## Example\n\nRefer to this project for examples.\n\n## Supported Environment\n\nCurrently, this project is tested in the following environment only:\n\n- **Build OS**:\n  - macOS\n- **Device**:\n  - ESP32-DevKitC(esp32)\n  - M5Stamp C3 Mate(esp32c3)\n\n## License\n\n[picoruby-esp32](https://github.com/yuuu/picoruby-esp32) is released under the [MIT License](https://github.com/yuuu/picoruby-esp32/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuuu%2Fpicoruby-esp32","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuuu%2Fpicoruby-esp32","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuuu%2Fpicoruby-esp32/lists"}