Skip to content

Commit 3ed84bf

Browse files
authored
Improve the README for crates published to crates.io (#40)
This removes the experimental warning and improves several documentation details.
1 parent 95f29ef commit 3ed84bf

File tree

3 files changed

+6
-12
lines changed

3 files changed

+6
-12
lines changed

crates/openvino-finder/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,15 @@ openvino-finder
33

44
A utility for locating OpenVINO™ libraries on a host system. It will attempt to find the OpenVINO
55
shared libraries in:
6+
- the `OPENVINO_BUILD_DIR` environment variable (pointed at a locally-built OpenVINO repository)
67
- the `OPENVINO_INSTALL_DIR` environment variable (pointed at the top-level OpenVINO installation,
7-
e.g. `/opt/intel/openvino`)
8+
e.g., `/opt/intel/openvino`)
89
- the `INTEL_OPENVINO_DIR` environment variable (same as above; this is set by OpenVINO setup
910
scripts)
1011
- the environment's library path (e.g., `LD_LIBRARY_PATH` in Linux; this is also set by the OpenVINO
1112
setup scripts)
1213
- OpenVINO's default installation paths for the OS (a best effort attempt)
1314

14-
> #### WARNING
15-
> This crate is currently experimental--its API surface is subject to change.
16-
1715
### Use
1816

1917
```Rust

crates/openvino-sys/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,9 @@
33
The [openvino-sys] crate provides low-level, unsafe, Rust bindings to OpenVINO™ using its [C API].
44
If you are looking to use OpenVINO™ from Rust, you likely should look at the ergonomic, safe
55
bindings in [openvino], which depends on this crate. See the repository [README] for more
6-
information, including build instructions.
7-
> #### WARNING
8-
> This crate is currently experimental--its API surface is subject to change.
6+
information, including instructions for configuring this crate at build time.
97

10-
[C API]: https://docs.openvinotoolkit.org/2020.1/ie_c_api/groups.html
8+
[C API]: https://docs.openvino.ai/latest/api/api_reference.html
119
[openvino-sys]: https://crates.io/crates/openvino-sys
1210
[openvino]: https://crates.io/crates/openvino
1311
[README]: https://github.com/intel/openvino-rs

crates/openvino/README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# openvino
22

33
The [openvino] crate provides high-level, ergonomic, safe Rust bindings to OpenVINO™. See the
4-
repository [README] for more information, such as build instructions.
5-
6-
> #### WARNING
7-
> This crate is currently experimental--its API surface is subject to change.
4+
repository [README] for more information, including instructions for configuring this crate at build
5+
time.
86

97
[openvino]: https://crates.io/crates/openvino
108
[README]: https://github.com/intel/openvino-rs

0 commit comments

Comments
 (0)