Skip to content
Permalink
trunk
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

artichoke/BUILD.md

Go to file
 
 
Cannot retrieve contributors at this time
Building Artichoke WebAssembly Prerequisites Rust Toolchain Installation Bindgen Rust Crates C Toolchain cc Crate mruby Bindings
123 lines (89 sloc) 3.52 KB
Raw Blame
Open in GitHub Desktop

Building Artichoke

To build Artichoke, install the prerequisites and run:

$ git clone https://github.com/artichoke/artichoke.git
$ cd ./artichoke
$ cargo build --release
$ ./target/release/artichoke --version
artichoke 0.1.0-pre.0

WebAssembly

Artichoke can be used in WebAssembly environments via the wasm32-unknown-emscripten target. This target is not tested in CI and should be considered unstable.

rustup target add wasm32-unknown-emscripten
cargo build --release --target wasm32-unknown-unknown

This on its own does not produce a usable artifact. To build a WebAssembly bundle, depend on artichoke in a crate with a main. See the artichoke/playground repository for an example.

Prerequisites

Rust Toolchain

Artichoke is a collection of Rust crates and requires a Rust compiler. The specific version of Rust Artichoke requires is specified in the toolchain file.

Artichoke only guarantees support for the latest stable version of the Rust compiler.

Installation

The recommended way to install the Rust toolchain is with rustup. On macOS, you can install rustup with Homebrew:

brew install rustup-init
rustup-init

On Windows, you can install rustup from the official site and follow the prompts: https://rustup.rs/. This requires a download of Visual Studio (the Community Edition is sufficient) and several C++ packages selected through the VS component installer. (I'm not sure which packages are required; I selected them all.)

Once you have rustup, you can install the Rust toolchain needed to compile Artichoke.

rustup toolchain install "$(cat rust-toolchain)"
rustup component add rustfmt
rustup component add clippy

Bindgen

Artichoke generates Rust declarations for C code at build time using bindgen. Although not required to build Artichoke, installing bindgen globally will speed up the compilation cycle.

To install bindgen using cargo:

cargo install --version 0.59.1 bindgen

Rust Crates

Artichoke depends on several Rust libraries, or crates. Once you have the Rust toolchain installed, you can install the crates specified in Cargo.lock by running:

cargo build --workspace

C Toolchain

Some artichoke dependencies, like the mruby sys FFI bindings and the onig crate, build C static libraries and require a C compiler.

Artichoke specifically requires clang. WebAssembly targets require clang-8 or newer.

On Windows, install the latest LLVM distribution from GitHub and add LLVM to your PATH: https://github.com/llvm/llvm-project/releases.

cc Crate

Artichoke and some of its dependencies use the Rust cc crate to build. cc uses a platform-dependent C compiler to compile C sources. On Unix, cc crate uses the cc binary.

mruby Bindings

To build the Artichoke mruby backend, you will need a C compiler toolchain. By default, mruby requires the following to compile:

  • clang
  • ar

You can override the requirement for clang by setting the CC and LD environment variables.