{"id":21509200,"url":"https://github.com/mark24code/mruby-devkit","last_synced_at":"2025-04-23T23:43:41.721Z","repository":{"id":243069713,"uuid":"811309558","full_name":"Mark24Code/mruby-devkit","owner":"Mark24Code","description":"开箱即用的脚手架，将 Ruby 编译成可执行二进制文件，就像 Go 一样。支持 webassembly","archived":false,"fork":false,"pushed_at":"2024-06-29T15:57:17.000Z","size":8615,"stargazers_count":6,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-30T04:41:31.721Z","etag":null,"topics":["c","cli","codebase","development","devkit","mruby","ruby","template-project","webassembly"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Mark24Code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-06-06T10:54:43.000Z","updated_at":"2024-12-01T09:12:52.000Z","dependencies_parsed_at":"2024-06-06T15:24:38.017Z","dependency_job_id":"9ad11455-07d1-42dc-b6ad-879fadcdd672","html_url":"https://github.com/Mark24Code/mruby-devkit","commit_stats":null,"previous_names":["mark24code/mruby-devkit"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark24Code%2Fmruby-devkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark24Code%2Fmruby-devkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark24Code%2Fmruby-devkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mark24Code%2Fmruby-devkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mark24Code","download_url":"https://codeload.github.com/Mark24Code/mruby-devkit/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250535057,"owners_count":21446503,"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":["c","cli","codebase","development","devkit","mruby","ruby","template-project","webassembly"],"created_at":"2024-11-23T21:21:22.396Z","updated_at":"2025-04-23T23:43:40.129Z","avatar_url":"https://github.com/Mark24Code.png","language":"Ruby","readme":"# MRuby Devkit\n\n![mruby](./doc/logo.png)\n\nMRuby Devkit 是一个开箱即用的脚手架。 基于 MRuby 将你的 Ruby 代码打包成 二进制可执行文件。\n\n方便开发类似于 Golang 的二进制可执行文件。\n\n\u003e —— 灵感来自于 Golang 可以编译为二进制可执行文件的迷人特性。\n\n---\n\n# 平台：\n\n- MacOS\n\n* x86_64 ✅\n* aarch64 ✅\n\n- Debian/Ubuntu/Mint Linux\n\n* x86_64 ✅\n* aarch64 ✅\n\n- WebAssembly ✅\n\n---\n\n# 一、使用约定\n\n## 前置运行环境\n\nMacOS、Linux\n\n- GCC/Clang\n- Make\n- Git\n- Ruby3\n\n  - Rake 安装 `gem install rake`\n\n- emscripten (如果需要转 webassembly)\n\n## 约定\n\n### 1. `src/main.rb` 程序入口\n\n程序入口不可修改。它是 `run`、`build` 寻找的入口。\n\n### 2. `src/lib/*.rb` 是多文件\n\nlib 中适合存放拆分的多文件。\n\n多文件中，如果存在依赖关系。需要特殊命名比如 01xxx， 02xxx …… 控制相对顺序。\n\n多文件最终会被拼接成一个上下文送入编译。\n\n### 3. `mruby.conf.rb` 是 mgem 配置文文件\n\n可以引入 [第三方 mgem ](https://mruby.org/libraries/)\n\n裁剪需要加入的 gem，控制编译选项。\n\n#### 注意：\n\n- 第三方标准库并不是每一个都可以被正确 build 比如 mgem-curses 无法 build，因为存在 BUG。\n- 要正确的配置编译选项，确保 mruby 产生。\n- 配置的 mgem 可以直接在上下文中使用，不需要 require\n\n## 差异\n\n- MRuby 和 CRuby 标准库有差异，请关注官方的文档\n- 工作模式是：裁剪 mgem 、功能，最后编译的解释器 + mruby 代码 进行联合工作。 mruby 代码不需要 require 语句导入包。\n- MRuby 有可能工作在嵌入式环境中，以及可能没有文件系统的硬件中。所以编译成 二进制应用。\n- MRuby 和 CRuby 内核不同。 MRuby 实现精简高效，全部采用可跨平台的 C 语言，内存实现高效，精简，适用于嵌入式、跨平台。\n- MRuby 更像是 C 项目在开发，需要了解 C 语言以及构建的概念\n\n---\n\n# 二、开发\n\n## 0. 编写程序\n\n`src` 下编写 ruby 程序\n\n## 1. 运行程序\n\n\u003e 模仿 golang 的 go run\n\n`rake run`\n\n## 2. 编译当前程序（默认使用当前计算机平台）\n\n\u003e 模仿 golang 的 go build\n\n`rake build`\n\n## 3.交叉编译的包\n\n借助 Github Action 编译不同平台的可执行二进制文件。\n\n- 可以 fork 仓库在 Github Action 运行结果下可以看到构建产物。\n\nGithub Action 提供免费的 Runner\n\n- Windows\n- MacOS AMD64\n- MacOS ARM64\n- Ubuntu AMD64\n\n如果你想获得 Linux aarch64 需要自建 Runner。\n\n你需要修改 [.github/workflows/raspbian-aarch64.yml](https://github.com/Mark24Code/mruby-devkit/blob/main/.github/workflows/raspbian-aarch64.yml) 使用自己的支持 aarch64 的 runner。\n\n### 3.1 WebAssembly 的说明\n\n```\nrake run:wasm    # run wasm program\nrake build:wasm  # build wasm program\n```\n\n提供两个命令支持 转换为 WebAssembly，注意 WebAssembly 并不支持所有 mgem，需要自己根据情况来编写。\n纯 Ruby 的逻辑 Wasm 支持。\n\n=======\n所以你需要修改 [.github/workflows/raspbian-aarch64.yml](https://github.com/Mark24Code/mruby-devkit/blob/main/.github/workflows/raspbian-aarch64.yml) 使用自己的支持 aarch64 的 runner。\n\n\u003e \u003e \u003e \u003e \u003e \u003e \u003e 7055a3e (update: readme)\n\n## 4. 内置 Rake 命令\n\nrake -T 查看可用命令\n\n```\n➜  build git:(main) rake -T\nrake build       # build program\nrake build:wasm  # build wasm program\nrake release     # release package\nrake run         # run program\nrake run:wasm    # run wasm program\n```\n\n---\n\n# TODO\n\n- [x] 交叉编译\n- [x] 多文件\n- [x] run 命令\n- [x] build 命令\n- [x] 自动初始化\n- [x] 支持 WebAssembly\n- [ ] require_relative\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmark24code%2Fmruby-devkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmark24code%2Fmruby-devkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmark24code%2Fmruby-devkit/lists"}