admin/mruby-mruby
1
0
Fork 0
mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Destroyed Building mruby (markdown)

bovi
2013-01-20 07:28:24 -08:00
parent a360d585a3
commit 11facbc6d2
1 changed files with 0 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Building-mruby.md
-58
@@ -1,58 +0,0 @@
Currently the mruby project provides two convenient ways to build mruby from source, a basic
Makefile structure for Unix-like systems, and a CMake-based build system for users wanting
multi-platform or cross compiling build support.
## Building with mruby's basic Makefile
**Prerequisites:**
* Bison and a build toolchain on `PATH`
Building with the Unix-style basic Makefiles is as you would expect. By default, a simple `make`
builds everything and installs executables into the project's `bin/` subdir, and libraries into
the project's `lib/` subdir. Valid build targets are listed by running `make help`. Interesting
build targets include:
1. `make clean all`
2. `make test`
## Building with CMake
CMake is a cross-platform, open-source build system that uses "build generators" enable a project
to be built on a large number of platforms with a wide variety of toolchains.
CMake allows contributors and users to focus on what they _want_ to do rather than unnecessary
ceremony just to get a working build.
Projects benefit because busy contributors don't waste time creating and maintaining multiple
custom build scripts for the different platforms and toolchains. Users benefit because they quickly
get a usable build without wasting time trying to create build files tailored to the system and
toolchain they're most productive with.
**Prerequisites:**
* CMake 2.8.8, Bison, and a build toolchain on `PATH`
* Except when generating Xcode or Visual Studio project files for IDE-based builds, CMake
configuration and command line builds must be performed _outside_ mruby's project root
directory. If you accidentally ran `cmake` in the root directory, delete the generated
`CMakeFiles/` subdirectory and `CMakeCache.txt` file, `cd` to another dir (hint: the included
`build` subdir), and re-run `cmake`.
### Native builds from the command line
_in process_, see this [introductory post](http://jonforums.github.com/ruby/2012/05/09/cmake-prototype-for-mruby.html) in the interm.
### Cross compiled builds from the command line
_in process_, see this [basic cross compiling post](http://jonforums.github.com/ruby/2012/05/13/cross-compiling-mruby.html) in the interm.
### Native OS X builds from the Xcode IDE
From mruby's root directory, run `cmake -G Xcode .` to generate Xcode project files. Open the
`mruby.xcodeproj` file in Xcode and hack away as you would with any other project. **Note:** do not
run CMake outside the root directory in another build directory because mruby's source files will
be _copied_ to the build directory. Any edits will occur to the _copied_ source files rather than
the real mruby source files, resulting in a very awkward, and potentially broken, workflow.
### Native Windows builds from the Visual Studio IDE
Run `cmake -G "Visual Studio 10" .` (or similar) from mruby's root directory to generate Visual
Studio project files. _in process_