# read-structure
Read structures is a library for working with strings that describe how the bases in a sequencing run should be allocated into logical reads.
Each read structure is made up of one or more read segments which are in turn a segment type.
For more details see [here](https://github.com/fulcrumgenomics/fgbio/wiki/Read-Structures)
## Documentation and Examples
Please see the generated [Rust Docs](https://docs.rs/read_structure).
## How to use in your project
Add the following to your `Cargo.toml` dependencies section, updating the version number as needed.
```toml
[dependencies]
read-structure = "*"
```
## How to build and test locally
Assuming you have cloned the repo and are in the top level:
```bash
cargo test
```
## How to publish
This assumes that you have installed `cargo-release` via `cargo install cargo-release` and have set up credentials with `crates.io`.
```bash
cargo release
```