# BBI.jl

This project follows the semver pro forma and uses the git-flow branching model.

## Description

BBI.jl handles the shared parts of bigWig.jl and bigBed.jl.

## Installation

BBI is bundled into the bigWig and bigBed packages, so you may not need to install this package explicitly. However, if you do, BBI is made available to install through BioJulia's package registry. By default, Julia's package manager only uses the "General" package registry. Your Julia configuration needs to include the BioJulia registry to be able to install the latest version of BBI.

To add the BioJulia registry from the Julia REPL, press ] to enter pkg mode, then enter the following command:

registry add https://github.com/BioJulia/BioJuliaRegistry.git

After adding the registry to your configuration, you can install BBI while in pkg mode with the following:

add BBI

If you are interested in the cutting edge of the development, please check out the develop branch to try new features before release.

## Testing

BBI is tested against Julia 1.X on Linux, OS X, and Windows.

Latest build status:

## Contributing

We appreciate contributions from users including reporting bugs, fixing issues, improving performance and adding new features.

Take a look at the contributing files detailed contributor and maintainer guidelines, and code of conduct.

### Financial contributions

We also welcome financial contributions in full transparency on our open collective. Anyone can file an expense. If the expense makes sense for the development the core contributors and the person who filed the expense will be reimbursed.