From 546f9781e985b91eb59805266dce3342600638ab Mon Sep 17 00:00:00 2001 From: kngwyu <yuji.kngw.80s.revive@gmail.com> Date: Wed, 22 Aug 2018 14:51:47 +0900 Subject: [PATCH] Some README additions --- README.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2aa7f7f03..624d65f61 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,29 @@ rust-numpy [](https://travis-ci.org/rust-numpy/rust-numpy) [](https://ci.appveyor.com/project/kngwyu/rust-numpy/branch/master) [](https://crates.io/crates/numpy) -[](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 @@ -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