{{ project-name }}

[](https://crates.io/crates/{{ project-name }}) [](https://docs.rs/{{ project-name }}) 

---

Warning: The library is currently in the early stages of development and is not yet ready for production use.

{{ project-name }}

Features

• serde - enables serialization using serde

Usage

Add this to your Cargo.toml:

[dependencies.{{ project-name }}]
features = []
version = "0.0.x"

Examples

Example #1: Basic Usage

    extern crate {{ project-name }};

    fn main() -> anyhow::Result<()> {

        Ok(())
    }

Getting Started

Prerequisites

Ensure you have the latest version of Rust installed. You can install Rust using rustup.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

After installation, I always recommend ensuring that rustup is updated to the latest version:

rustup update

And to add the latest nightly toolchain, which is often useful for development:

rustup toolchain install nightly

Additionally, you may wish to install the cargo-binstall utility to streamline the installation of Rust binaries:

cargo install cargo-binstall

If necessary, add the wasm32-* target(s) if you plan to compile for WebAssembly:

rustup target add wasm32-unknown-unknown wasm32-p1 wasm32-p2

Building from the source

Start by cloning the repository

git clone https://github.com/{{ alias }}/{{ project-name }}.git -b main --depth 1

Then, navigate to the project directory:

cd {{ project-name }}

Once you're in the project directory, you can build the project using cargo:

cargo build --workspace --release --all-features

Or, if you want to run the tests, you can use:

cargo test --workspace --release --all-features

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.