Skip to content

Commit

Permalink
README updates
Browse files Browse the repository at this point in the history
  • Loading branch information
pauldmccarthy committed Oct 16, 2016
1 parent 8e522a5 commit b373065
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,23 +71,25 @@ sizes, with 1000 seeks:
## Installation


1. Make sure you have [cython](http://cython.org/) installed.


2. Install into your Python environment:
```sh
pip install git+https://github.com/pauldmccarthy/indexed_gzip.git
```

`indexed_gzip` is available on [PyPi](https://pypi.python.org/pypi) - to
install, simply type:
```sh
pip install indexed_gzip
```

3. Or, if you don't want to install, compile the python extension:
To compile `indexed_gzip`, make sure you have [cython](http://cython.org/)
installed, and then run:
```sh
python setup.py build_ext --inplace
```

And put the `indexed_gzip` directory on your `$PYTHONPATH`.


To run the tests, type the following; you will need `numpy` and `pytest`
installed:
```sh
python setup.py test
```

## Usage


Expand Down

0 comments on commit b373065

Please sign in to comment.