Skip to content

Commit

Permalink
Add installation information to the README
Browse files Browse the repository at this point in the history
  • Loading branch information
person142 committed Jul 7, 2019
1 parent 8b36fb8 commit 13044f2
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
Numba special allows SciPy's special functions to be used in
Numba.

## How to use it

```python
>>> import numba
>>> import scipy.special as sc
Expand All @@ -20,3 +22,11 @@ Numba.
For detailed information on which functions can be used from Numba,
check the
[documentation](https://numba-special.readthedocs.io/en/latest/).

## Installing

Building and installing `numba_special` requires Cython, SciPy, and
Numba. Until the fix for [this
issue](https://github.com/numba/numba/issues/4133) is included in a
Numba release, `numba_special` must be built against the master branch
of Numba.

0 comments on commit 13044f2

Please sign in to comment.