Skip to content

Commit 546f978

Browse files
committed
Some README additions
1 parent cb16390 commit 546f978

File tree

1 file changed

+15
-6
lines changed

1 file changed

+15
-6
lines changed

README.md

+15-6
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,29 @@ rust-numpy
33
[![Build Status](https://travis-ci.org/rust-numpy/rust-numpy.svg?branch=master)](https://travis-ci.org/rust-numpy/rust-numpy)
44
[![Build status](https://ci.appveyor.com/api/projects/status/bjaru43c7t1alx2x/branch/master?svg=true)](https://ci.appveyor.com/project/kngwyu/rust-numpy/branch/master)
55
[![Crate](http://meritbadge.herokuapp.com/numpy)](https://crates.io/crates/numpy)
6-
[![docs.rs](https://docs.rs/numpy/badge.svg)](https://docs.rs/numpy)
76

87
Rust binding of NumPy C-API
98

10-
Dependencies
9+
API documentation
1110
-------------
11+
- [Latest release(can be broken)](https://docs.rs/numpy)
12+
- [Current Master](https://rust-numpy.github.io/rust-numpy)
1213

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

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

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

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

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

96105
- v0.2.1
97106
- NEW: trait `IntoPyErr`, `IntoPyResult` for error translation

0 commit comments

Comments
 (0)