Skip to content

Commit

Permalink
add installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
stolarczyk committed Feb 4, 2020
1 parent ae4b90b commit f5f7a3a
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,22 @@

## Installation

Install from [GitHub releases](https://github.com/databio/bbconf/releases) or from PyPI using `pip`:
Currently, there's no released version since `bbconf` is under rapid development so the only way to install the package is:

1. Clone this repository
```bash
git clone https://github.com/databio/bbconf.git
```
pip install --user bbconf
2. Install the local package
```bash
pip install ./bbconf
```

<!--- Install from [GitHub releases](https://github.com/databio/bbconf/releases) or from PyPI using `pip`: --->
<!---```--->
<!---pip install --user bbconf--->
<!---```--->

## Usage

- [Usage demonstration](https://github.com/databio/bbconf/blob/master/docs/demo.ipynb)
Expand Down

0 comments on commit f5f7a3a

Please sign in to comment.