The vsvg project (incl. whiskers and msvg)

What's this?

whiskers	msvg	vsvg/vsvg-viewer
whiskers is a Rust-based, Processing-like interactive sketching environment for generative plotter art. It's fast, it's web-ready, and it's a delight to use. Try it here!	msvg is a (WIP!) fast browser for SVG collections. It smoothly addresses the challenge of browsing through large collections of generated SVGs, e.g. to find the best looking ones for plotting.	vsvg and vsvg-viewer are the core crates behind whiskers and msvg. They implement the core data structures for manipulating vector data for plotter applications, as well as an ultra-performant, cross-platform, hardware-accelerated, and easy-to-extend viewer.

Documentation

The documentation is WIP—watch this space for updates.

In the meantime, each crate of the vsvg project has its own README with additional information:

• whiskers
• whiskers-widgets
• whiskers-derive
• msvg
• vsvg
• vsvg-viewer
• vsvg-cli

Installing

There is currently no facilities to install vsvg unfortunately. It must be compiled and installed from source. Fortunately, this is actually not much more complicated than running a Python executable.

First, install Rust by running the command provided by the official Rust website:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Normally, this will add $HOME/.cargo/bin in your path.

Then, download the vsvg source code:

git clone https://github.com/abey79/vsvg
cd vsvg

Running the sketch examples

See whiskers's README.md.

Installing vsvg-cli

See vsvg-cli's README.md.

Design notes

A few design considerations can be found here. They concern the use of this project as basis for a possible future Rust-based vpype-core package.

Licence

This project is available under the MIT licence.