Skip to content

Commit bd39656

Browse files
committed
make a note you don't need to touch tools C file
1 parent fe07452 commit bd39656

2 files changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ MRuby::Gem::Specification.new('hello_world') do |spec|
6565
end
6666
```
6767
### CLI Architecture
68-
The app is built from two parts a C wrapper in `tools/` and a mruby part in `mrblib/`. The C wrapper is fairly minimal and executes the `__main__` method in mruby and instantiates ARGV and passes it to the mruby code. The rest of the CLI is written in mruby. You can't have subfolders in `mrblib/` but you can have as many files in `mrblib/`. All these files are precompiled into mruby bytecode The build tool for mruby is written in CRuby (MRI).
68+
The app is built from two parts a C wrapper in `tools/` and a mruby part in `mrblib/`. The C wrapper is fairly minimal and executes the `__main__` method in mruby and instantiates `ARGV` and passes it to the mruby code. You won't need to touch the C wrapper. The rest of the CLI is written in mruby. You can't have subfolders in `mrblib/` but you can have as many files in `mrblib/`. All these files are precompiled into mruby bytecode The build tool for mruby is written in CRuby (MRI).
6969

7070
### Testing
7171
By default, `mruby-cli` generates two kinds of tests: mtest and bintest.

mrblib/setup.rb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,7 @@ def gem_config(conf)
214214

215215
def tools
216216
<<TOOLS
217+
// This file is generated by mruby-cli. Do not touch.
217218
#include <stdlib.h>
218219
#include <stdio.h>
219220

0 commit comments

Comments
 (0)