Skip to content

Commit

Permalink
Some README additions
Browse files Browse the repository at this point in the history
  • Loading branch information
kngwyu committed Aug 22, 2018
1 parent cb16390 commit 546f978
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,29 @@ rust-numpy
[![Build Status](https://travis-ci.org/rust-numpy/rust-numpy.svg?branch=master)](https://travis-ci.org/rust-numpy/rust-numpy)
[![Build status](https://ci.appveyor.com/api/projects/status/bjaru43c7t1alx2x/branch/master?svg=true)](https://ci.appveyor.com/project/kngwyu/rust-numpy/branch/master)
[![Crate](http://meritbadge.herokuapp.com/numpy)](https://crates.io/crates/numpy)
[![docs.rs](https://docs.rs/numpy/badge.svg)](https://docs.rs/numpy)

Rust binding of NumPy C-API

Dependencies
API documentation
-------------
- [Latest release(can be broken)](https://docs.rs/numpy)
- [Current Master](https://rust-numpy.github.io/rust-numpy)

- [rust-ndarray](https://github.com/bluss/rust-ndarray)
- [pyo3](https://github.com/PyO3/pyo3)

and more (see [Cargo.toml](Cargo.toml))
Dependencies
-------------
- nightly version of rust compiler (see [pyo3](https://github.com/PyO3/pyo3))
- some rust libraries
- [rust-ndarray](https://github.com/bluss/rust-ndarray) for rust-side matrix library
- [pyo3](https://github.com/PyO3/pyo3) for cpython binding
- and more (see [Cargo.toml](Cargo.toml))
- [numpy](http://www.numpy.org/) installed in your python environments(e.g. via `pip install numpy`)

**Note**
From 0.3, we migrated from rust-cpython to pyo3.
If you want rust-cpython, use version 0.2.1 from crates.io.


Example
---------
Please see [example](example) directory for a complete example
Expand Down Expand Up @@ -86,12 +93,14 @@ fn rust_ext(py: Python, m: &PyModule) -> PyResult<()> {
Contribution
-------------
This project is in pre-alpha version.
We need your feedback. Don't hesitate to open [issue](https://github.com/termoshtt/rust-numpy/issues)!
We need your feedback. Don't hesitate to open [issues](https://github.com/termoshtt/rust-numpy/issues)!

Version
--------
- v0.3.0
- Breaking Change: Migrated to pyo3 from rust-cpython
- Some api addition
- [Static type checking with PhantomData](https://github.com/rust-numpy/rust-numpy/pull/41)

- v0.2.1
- NEW: trait `IntoPyErr`, `IntoPyResult` for error translation
Expand Down

0 comments on commit 546f978

Please sign in to comment.