spf 0.8.0-alpha.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

/*
 * Copyright 2025 SimplePixelFont
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#![allow(unused_imports)] // Otherwise we get warnings about unused imports even though they are used in the docs.
//! Helpful guides and learning resources to integrate spf.rs in your next project.

pub(crate) use crate::core::*;
// pub(crate) use crate::ergonomics::*;
// pub(crate) use crate::printer::*;
pub(crate) use crate::*;

// /// Guide for `spf.rs` printer module and creating text renderings.
// pub mod printer_guide {
//     #![doc = include_str!("../res/articles/PrinterModuleAndTextRenderings.md")]
// }

// /// Guide for spf.rs basics and understanding the file format via Rust.
// pub mod getting_started {
//     #![doc = include_str!("../res/articles/GettingStartedInRust.md")]
// }

/// Guide for installing `spf.rs` crate and dynamic FFI library.
pub mod installing {
    #![doc = include_str!("../res/articles/InstallingSPFRS.md")]
}

/// Guide for using `spf.rs` as an FFI library in C.
pub mod c_usage {
    #![doc = include_str!("../res/articles/UsingSPFRSWithFFI.md")]
}