Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Installation

CLI

Install from source using Cargo:

cargo install --git https://github.com/Syynth/brink brink-cli

This builds and installs the brink binary. No prebuilt binaries are available yet.

Library

Add brink-runtime to your project. Since brink is not yet published to crates.io, use a git dependency:

[dependencies]
brink-runtime = { git = "https://github.com/Syynth/brink" }

If you also need the compiler (to compile .ink source at build time or runtime):

[dependencies]
brink-compiler = { git = "https://github.com/Syynth/brink" }
brink-runtime = { git = "https://github.com/Syynth/brink" }

The brink-runtime crate is the primary library interface. It depends only on brink-format (the binary interface) and has no compiler dependencies.