Skip to content

Commit b02bb37

Browse files
committed
The repo is renamed; update metadata, readme etc
1 parent 4f1c74a commit b02bb37

File tree

4 files changed

+25
-21
lines changed

4 files changed

+25
-21
lines changed

CHANGELOG.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,12 @@
3232

3333
### Changed
3434

35+
- Renamed `hdf5-rs` crate (importable as `h5`) to `hdf5` (importable simply as `hdf5`).
36+
- Renamed `libhdf5-sys` crate to `hdf5-sys` (importable as `hdf5_sys`).
37+
- Renamed GitHub repository to `aldanor/hdf5-rust`.
3538
- Updated the bindings and tests to the latest HDF5 versions (1.10.4 and 1.8.21).
3639
- The build system has been reworked from the ground up:
37-
- `libhdf5-lib` crate has been removed; all of the build-time logic now resides
40+
- `hdf5-lib` crate has been removed; all of the build-time logic now resides
3841
in the build script of `hdf5-sys`.
3942
- The environment variables the build script reacts to are now `HDF5_DIR` and `HDF5_VERSION`.
4043
- `pkg-config` is now only launched on Linux.
@@ -66,7 +69,7 @@
6669

6770
### Removed
6871

69-
- Removed `libhdf5-lib` crate (merged it into `hdf5-sys`, see above).
72+
- Removed `hdf5-lib` crate (merged it into `hdf5-sys`, see above).
7073
- Removed `remutex` crate, using locking primitives from `parking_lot` crate instead.
7174
- `Container` trait has been removed, all of its functionality merged into `Group` type.
7275

@@ -81,13 +84,13 @@
8184
the `bin` folder of HDF5 installation, the library directory will be inferred automatically.
8285
The official HDF5 installers add the `bin` folder to user path, so the official MSVC releases
8386
should just work out of the box without having to set any environment variables.
84-
- The library is now split into three crates: `libhdf5-lib` (requests linkage to HDF5),
85-
`hdf5-sys` (contains bindings, requires `libhdf5-lib` at build time in order to conditionally
86-
enable or disable certain HDF5 functionality), and `hdf5-rs` (the user-facing crate, requires
87+
- The library is now split into three crates: `hdf5-lib` (requests linkage to HDF5),
88+
`hdf5-sys` (contains bindings, requires `hdf5-lib` at build time in order to conditionally
89+
enable or disable certain HDF5 functionality), and `hdf5` (the user-facing crate, requires
8790
both lower-level crates at build time).
8891
- Added `hdf5::hdf5_version` function.
8992
- The minimum required version of the HDF5 library is now 1.8.4.
90-
- Both `hdf5-sys` and `hdf5-rs` crates can now use version attributes at compile time to
93+
- Both `hdf5-sys` and `hdf5` crates can now use version attributes at compile time to
9194
enable/disable/change functionality. All functions and definitions that appeared in HDF5 versions
9295
past 1.8.4 are now conditionally enabled in `hdf5-sys`.
9396
- Added bindings for HDF5 functions that were added in releases 1.8.15 and 1.8.16.

Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ keywords = ["hdf5"]
66
license = "MIT/Apache-2.0"
77
readme = "README.md"
88
description = "Thread-safe Rust bindings for the HDF5 library."
9-
repository = "https://github.com/aldanor/hdf5-rs"
10-
homepage = "https://github.com/aldanor/hdf5-rs"
9+
repository = "https://github.com/aldanor/hdf5-rust"
10+
homepage = "https://github.com/aldanor/hdf5-rust"
1111
build = "build.rs"
1212
edition = "2018"
1313

README.md

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
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

1011
Requires 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
7677
a 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
8889
HDF5 library that they are being linked against, and some functionality may be conditionally
8990
enabled or disabled at compile time. While this allows supporting multiple versions of HDF5
9091
in 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
132133
HDF5 and is generally the recommended way to go. That being said, previous experiments have
133134
shown 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
153154
Apache License (Version 2.0). See [LICENSE-APACHE](LICENSE-APACHE) and
154155
[LICENSE-MIT](LICENSE-MIT) for details.

hdf5-sys/Cargo.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ authors = ["Ivan Smirnov <[email protected]>"]
55
keywords = ["hdf5"]
66
license = "MIT/Apache-2.0"
77
build = "build.rs"
8-
repository = "https://github.com/aldanor/hdf5-rs"
9-
homepage = "https://github.com/aldanor/hdf5-rs"
8+
repository = "https://github.com/aldanor/hdf5-rust"
9+
homepage = "https://github.com/aldanor/hdf5-rust"
1010
description = "Native bindings to the HDF5 library."
1111
edition = "2018"
1212

0 commit comments

Comments
 (0)