atliac-crate-template 0.0.2

A minimal Rust crate template for kickstarting library development
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

//! # atliac-crate-template
//!
//! A minimal, production-ready Rust template designed to jumpstart library (crate) development.
//! It establishes a workspace-friendly structure and comes pre-configured with automated release
//! pipelines, versioning, and cross-platform distribution.
//!
//! ## Example
//!
//! ```rust
//! use atliac_crate_template::add;
//!
//! assert_eq!(add(2, 3), 5);
//! ```

/// Adds two numbers.
///
/// This is a placeholder function to demonstrate the library structure.
///
/// # Examples
///
/// ```rust
/// use atliac_crate_template::add;
///
/// let result = add(2, 2);
/// assert_eq!(result, 4);
/// ```
pub fn add(left: u64, right: u64) -> u64 {
    left + right
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn add_works() {
        let result = add(2, 2);
        assert_eq!(result, 4);
    }
}