Permalink
Browse files

[doc] Add minimal build configuration

In relation to #1225.

Adds a minimal build configuration for libmruby which contains as less as possible.
  • Loading branch information...
1 parent 8e45630 commit 2991c8b0b22bc19f6137b2468fa6daaedca87a7b @bovi bovi committed May 8, 2013
Showing with 19 additions and 0 deletions.
  1. +19 −0 doc/compile/README.md
View
@@ -346,6 +346,25 @@ linking with *build/i386/lib/libmruby_core.a*
----------------------------------------------------------------
```
+## Build Configuration Examples
+
+### Minimal Library
+
+To build a minimal mruby library you need to use the Cross Compiling
+feature due to the reason that there are functions (i.e. stdio) which
+can't be disabled for the main build.
+
+ MRuby::CrossBuild.new('Minimal') do |conf|
+ toolchain :gcc
+
+ conf.cc.defines = %w(DISABLE_STDIO)
+ conf.bins = []
+ end
+
+This configuration defines a cross compile build called 'Minimal' which
+is using the GCC and compiles for the host machine. It also disables
+all usages of stdio and doesn't compile any binaries (i.e. mrbc).
+
## Test Environment
mruby's build process includes a test environment. In case you start the testing

0 comments on commit 2991c8b

Please sign in to comment.