To bootstrap a development environment, please use the following commands.
# Clone the repository
git clone [email protected]:stjudecloud/ecc.git
cd ecc
# Build the crate in release mode
cargo build --release
# List out the examples
cargo run --release --exampleBefore submitting any pull requests, please make sure the code passes the following checks (from the root directory).
# Run the project's tests.
cargo test --all-features
# Run the tests for the examples.
cargo test --examples --all-features
# Ensure the project doesn't have any linting warnings.
cargo clippy --all-features
# Ensure the project passes `cargo fmt`.
# Currently this requires nightly Rust
cargo +nightly fmt --check
# Ensure the docs build.
cargo docContributions, issues and feature requests are welcome! Feel free to check issues page.
This project is licensed as either Apache 2.0 or MIT at your discretion.
Copyright © 2024-Present St. Jude Children's Research Hospital.