Guiding Principles
This crate is written in the style of noodles, as it was originally intended to be included as a pull request. After discussion with the maintainer of noodles, we decided this should be its own, complimentary crate.
📚 Getting Started
To include this crate in your project, simply use the following command.
You can take a look at the examples to get a sense of how to use the crate.
🖥️ Development
To bootstrap a development environment, please use the following commands.
# Clone the repository
# Build the crate in release mode
# List out the examples
🚧️ Tests
Before submitting any pull requests, please make sure the code passes the following checks.
# Run the project's tests.
# Ensure the project doesn't have any linting warnings.
# Ensure the project passes `cargo fmt`.
Minumum Supported Rust Version (MSRV)
This crate is designed to work with Rust version 1.72.0 or later. It may, by happenstance, work with earlier versions of Rust.
🤝 Contributing
Contributions, issues and feature requests are welcome! Feel free to check issues page.
📝 License
This project is licensed as either Apache 2.0 or MIT at your discretion.
Copyright © 2023-Present St. Jude Children's Research Hospital.