InstallingSPFRS

Installing with Cargo and Rust

To add spf.rs to your rust project you can run the following command:

cargo add spf

spf.rs also has a lot of modules which are enabled by default with the corrosponding features; [crate::log] ("log"), [crate::cache] ("cache"), [crate::printer] ("printer"), [crate::ergonomics] (ergonomics), [crate::ffi] ("ffi"), and [crate::articles] ("articles").

You can choose which features to use by editing the Cargo.toml file under the depenencies section:

# Example
[dependencies]
spf = { version = "0.4", default-features = false, features = ["cache"]}

Compiling spf.rs from source

Sometimes you may wish to compile the spf.rs library by hand. This is especially true if a pre-built binary is not available for your OS in the releases section. For this you will need the following: - Rust Programming Language - Git (Optional)

To begin we will first clone the repository with the following command:

git clone
# If you chose to not use Git, you can also download the spf.rs repo and cd into the downloaded directory, ex.
cd downloads/spf.rs

Now you can run:

cargo build --release

And if you check ./target/release/ you should find a spf.dll, libspf.so, etc. (depending on your OS). Now you can use this library in your programming language of choice.