twentyone

A blackjack engine for Rust.

Building & Testing

To build the project, run cargo build in the project's root directory.

To test the project, run cargo test. To show output from tests with prints, run cargo test -- --nocapture.

To build project documentation, run cargo doc in the project's root directory. Generated documentation will be available at /target/doc/twentyone/index.html.

Examples

To run an included example, run cargo run --example example_name. For example, to run the solo_cli example, you would run cargo run --example solo_cli.

Including as a dependency

Via crates.io

To add this project as a dependency via crates.io, add the following to your Cargo.toml dependencies:

[dependencies]
twentyone = "0.2"

Via git

To add this project as a dependency via the git repository, add the following to your Cargo.toml dependencies:

[dependencies]
twentyone = { git = "https://github.com/MysteryBlokHed/twentyone" }

To add a speific release as a dependency using a branch:

[dependencies]
twentyone = { git = "https://github.com/MysteryBlokHed/twentyone", branch = "release/0.1.0" }

Via a local build

After building this project, to add it as a dependency elsewhere, add the following to your Cargo.toml dependencies:

[dependencies]
twentyone = { path = "/path/to/build/location" }

Documentation

Documentation is available at https://docs.rs/twentyone/.

License

This project is licensed under the Apache License, Version 2.0 (LICENSE or https://www.apache.org/licenses/LICENSE-2.0).