🐢⚡ Webviz Rust Framework (Wrflib)

Wrflib is a fast, cross-platform (web+native), GPU-based application framework, written in Rust.

We're a small team at Cruise building an internal application and this framework at the same time. It's in early stages of development, so don't expect too much yet!

The current supported workflow is to clone this repo and then add your own package to the root Cargo.toml.

Development

Installing

• Install Rust
• Install cargo extension for Wrflib cargo install cargo-wrflib
• Run the dependency installation using Wrflib cargo tool cargo wrflib install-deps

Cargo extension

Wrflib provides a cargo extension that can be used to perform different tasks. The extension can be installed like this: cargo install cargo-wrflib

Optionally, you can use the tool directly like so cargo run -p cargo-wrflib, as any other project.

Docs

• Install Rust
• Run wrflib/scripts/build_website_dev.sh to generate our docs website. Follow the instructions on how to view them.
• When developing docs, use wrflib/scripts/watch_website_dev.sh to watch for changes.
• When publishing the docs, run wrflib/scripts/build_website_prod.sh which copies only the relevant files.

Makepad repo

Originally we forked the Makepad Framework, but we've heavily modified the codebase since then, and are pursuing our own vision. The editor itself is still around, but has also been heavily modified and has way fewer features; it can be found in wrflib/examples/example_bigedit.

License

Wrflib is primarily distributed under the terms of both the MIT license and the Apache License (version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.