spf 0.9.0

.spf (Simple Pixel Font) file parser
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# Install `spf` crate with Cargo and Rust

To add `spf.rs` to your rust project, run the following command:
```bash
cargo add spf
```

Additionally, `spf.rs` includes modules which are enabled by default with the corresponding features.

* ffi: [`crate::ffi`]
* tagging: [`crate::tagging`]
* articles: [`crate::articles`]

And a few extra features for convenience and integration, also enabled by default.

* log: Integrate with Rust's log ecosystem.
* serde: Integrate with Rust's serde (serialization and deserialization) ecosystem.
* std: Add dependency on Rust's std crate which handles heap allocations automatically. You can disable this feature to allow a custom heap allocator, and use spf.rs on low-level and embedded hardware.

You can choose which features to use by editing the `Cargo.toml` file under the dependencies section, such as (pin whichever version of `spf` you want from [crates.io](https://crates.io/crates/spf)):
```toml
[dependencies]
spf = { version = "0.8", default-features = false, features = ["ffi", "std"]}
```

# Compile `spf.rs` library from source

Compiling the `spf.rs` library by hand is useful if you want to create a custom version of the library, and enable only modules your projects need. This can decrease the resulting binary size, and allow you to target platforms which don't have pre-built artifacts in the releases section. To compile `spf.rs` from source you will need the following prerequisites.

* [Rust Programming Language](https://rust-lang.org/tools/install/)
* [Git](https://git-scm.com/install/) (Optional)

Begin by cloning the repository with the following command:
```bash
git clone https://github.com/SimplePixelFont/spf.rs.git
# Alternatively, download the spf.rs repository and "cd" into the downloaded directory.
# cd downloads/spf.rs
```
Now run the following command.
```bash
# "--no-default-features" removes all default spf features from the current build as currently spf only compiles with features that do not require crate dependencies.
# "--features" specifies a list of features to compile the library with, currently the following work: "std", "ffi", "tagging", and "articles".
# "--crate-type cdylib" produces a dynamic library which can be loaded at runtime.
# "--crate-type staticlib" produces a static library which can be linked at compile time.
# "target-feature=-crt-static" is used to fix static linking errors occurring in builds on some architectures. "cargo rustc" is also used in order to pass this Compiler flag
cargo rustc --release --no-default-features --features "ffi,std" -- --crate-type cdylib --crate-type staticlib -C target-feature=-crt-static
```
In `./target/release/` you should find a `spf.dll`, `libspf.so`, etc. (depending on your OS). This library can now be used in your programming language of choice.