wasm-bindgen/CONTRIBUTING.md
2018-03-29 08:27:31 -07:00

994 B

Contributing

This document contains instructions on how to get this project up and running. For more information on the architecture, design, and goals of this project please checkout DESIGN.md.

Prerequisites

  1. Rust Nightly. Install Rust. Once Rust is installed, run

    rustup default nightly
    
  1. The tests for this project use Node. Make sure you have node >= 8 installed, as that is when WebAssembly support was introduced. Install Node.
  1. The tests for this project also use yarn, a package manager for Node. To install yarn, run:

    npm install yarn -g
    

    ... or follow other platform-specific instructions here.

    Once yarn is installed, run it in the top level directory:

    yarn
    

    Finally, you can run the tests with cargo:

    cargo test