Lib.rs

SFX is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install sfx

It will make the sfx command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall sfx uninstalls.

Adding sfx library as a dependency

Run this command in a terminal, in your project's directory:

cargo add sfx

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

sfx = "0.1.1"

The sfx library will be automatically available globally. Read the sfx library documentation.

Back to the crate overview.

---