Skip to content

Commit

Permalink
README.md (#129)
Browse files Browse the repository at this point in the history
fixed typos
  • Loading branch information
jarede-dev authored Nov 20, 2022
1 parent 68b775d commit 0b8f10f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ miniz_oxide 0.5.x and 0.6.x Requires at least rust 1.40.0, 0.3.x requires at lea
For a friendlier streaming API using readers and writers, [flate2](https://crates.io/crates/flate2) can be used, which can use miniz_oxide as a rust-only back-end.

## miniz_oxide_C_API
The C API is intended to replicate the api exported from miniz, and in turn also part of zlib. The C header is generated using [cbindgen](https://github.com/eqrion/cbindgen). The current implementation has not seen a lot of testing outside of automated test, is a bit weak in documentation and should be seen as experimental.
The C API is intended to replicate the API exported from miniz, and in turn also part of zlib. The C header is generated using [cbindgen](https://github.com/eqrion/cbindgen). The current implementation has not seen a lot of testing outside of automated tests, is a bit weak in documentation and should be seen as experimental.

The data structures do not share the exact same layout that is specified in miniz.h (from the original miniz), and should thus be allocated via the included functions.

Expand All @@ -39,7 +39,7 @@ $ ./travis-after-success.sh

### Including in C/C++ projects

Link against the `libminiz_oxide_c_api.a` generated by `build.sh`. The generated header that can be used `miniz.h` (using the original miniz headers may or may not work), which currently also uses `miniz_extra_defs.h` for some static definitions.
Link against the `libminiz_oxide_c_api.a` generated by `build.sh`. The generated header that can be used is `miniz.h` (using the original miniz headers may or may not work), which currently also uses `miniz_extra_defs.h` for some static definitions.

### Cargo-fuzz testing

Expand Down

0 comments on commit 0b8f10f

Please sign in to comment.