1- # hdf5-rs
1+ # ` hdf5 `
22
3- [ ![ Build Status] ( https://img.shields.io/travis/aldanor/hdf5-rs .svg )] ( https://travis-ci.org/aldanor/hdf5-rs ) [ ![ Appveyor Build Status] ( https://img.shields.io/appveyor/ci/aldanor/hdf5-rs .svg )] ( https://ci.appveyor.com/project/aldanor/hdf5-rs )
3+ [ ![ Build Status] ( https://img.shields.io/travis/aldanor/hdf5-rust .svg )] ( https://travis-ci.org/aldanor/hdf5-rust ) [ ![ Appveyor Build Status] ( https://img.shields.io/appveyor/ci/aldanor/hdf5-rust .svg )] ( https://ci.appveyor.com/project/aldanor/hdf5-rust )
44
5- [ Documentation] ( https://docs.rs/crate/hdf5-rs )
6- [ Changelog] ( https://github.com/aldanor/hdf5-rs /blob/master/CHANGELOG.md )
5+ [ Documentation] ( https://docs.rs/crate/hdf5 )
6+ [ Changelog] ( https://github.com/aldanor/hdf5-rust /blob/master/CHANGELOG.md )
77
8- Thread-safe Rust bindings and high-level wrappers for the HDF5 library API.
8+ The ` hdf5 ` crate provides thread-safe Rust bindings and high-level wrappers for
9+ the HDF5 library API.
910
1011Requires HDF5 library of version 1.8.4 or later.
1112
@@ -67,12 +68,12 @@ fn main() -> hdf5::Result<()> {
6768
6869### Platforms
6970
70- ` hdf5-rs ` is known to run on these platforms: Linux, macOS, Windows (tested on Travis CI and
71- AppVeyor, HDF5 1.8 and 1.10, system installations and conda environments).
71+ ` hdf5 ` crate is known to run on these platforms: Linux, macOS, Windows (tested on Travis
72+ CI and AppVeyor, HDF5 1.8 and 1.10, system installations and conda environments).
7273
7374### Rust
7475
75- ` hdf5-rs ` is tested continuously for all three official release channels, and requires
76+ ` hdf5 ` crate is tested continuously for all three official release channels, and requires
7677a modern Rust compiler (e.g. of version 1.31 or later).
7778
7879### HDF5
@@ -84,7 +85,7 @@ threadsafe option enabled.
8485
8586### HDF5 version
8687
87- Build scripts for both ` hdf5-sys ` and ` hdf5-rs ` crates check the actual version of the
88+ Build scripts for both ` hdf5-sys ` and ` hdf5 ` crates check the actual version of the
8889HDF5 library that they are being linked against, and some functionality may be conditionally
8990enabled or disabled at compile time. While this allows supporting multiple versions of HDF5
9091in a single codebase, this is something the library user should be aware of in case they
@@ -127,7 +128,7 @@ unless `HDF5_VERSION` is set.
127128
128129### Windows
129130
130- ` hdf5-rs ` fully supports MSVC toolchain, which allows using the
131+ ` hdf5 ` crate fully supports MSVC toolchain, which allows using the
131132[ official releases] ( https://www.hdfgroup.org/downloads/index.html ) of
132133HDF5 and is generally the recommended way to go. That being said, previous experiments have
133134shown that all tests pass on the ` gnu ` target as well, one just needs to be careful with
@@ -149,6 +150,6 @@ Few things to note when building on Windows:
149150
150151## License
151152
152- ` hdf5-rs ` is primarily distributed under the terms of both the MIT license and the
153+ ` hdf5 ` crate is primarily distributed under the terms of both the MIT license and the
153154Apache License (Version 2.0). See [ LICENSE-APACHE] ( LICENSE-APACHE ) and
154155[ LICENSE-MIT] ( LICENSE-MIT ) for details.
0 commit comments