Skip to content

Commit b9c011e

Browse files
committed
Update README
Include info about the static library option.
1 parent 4493d60 commit b9c011e

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ So I wrote one. :)
2424

2525
## Other languages
2626

27-
Supplies a [C/C++ compatible shared library](#cc-compatible-shared-library) for use with other non-`Rust` languages.
27+
Supplies a [C/C++ compatible library](#cc-compatible-library) for use with other non-`Rust` languages.
2828

2929
## Implementations
3030

@@ -39,8 +39,7 @@ See [CHANGELOG](CHANGELOG.md).
3939
## Build & Install
4040

4141
`cargo build` will obviously build the library, including
42-
the [C-compatible shared library](#c-compatible-shared-library). There are fine-tuning [feature flags](Cargo.toml)
43-
available, should they be necessary for your deployment and [acceleration](#acceleration-targets) targets.
42+
the [C-compatible library](#cc-compatible-library).
4443

4544
A _very_ basic [Makefile](Makefile) is supplied which supports `make install` to install the shared library and header
4645
file to
@@ -248,11 +247,12 @@ let checksum = checksum_file_with_params(custom_params, file_on_disk, None);
248247
assert_eq!(checksum.unwrap(), 0xcbf43926);
249248
```
250249

251-
## C/C++ compatible shared library
250+
## C/C++ compatible library
252251

253252
`cargo build` will produce a shared library target (`.so` on Linux, `.dll` on Windows, `.dylib` on macOS, etc) and an
254253
auto-generated [libcrc_fast.h](libcrc_fast.h) header file for use in non-Rust projects, such as through
255-
[FFI](https://en.wikipedia.org/wiki/Foreign_function_interface).
254+
[FFI](https://en.wikipedia.org/wiki/Foreign_function_interface). It will also produce a static library target (`.a` on Linux and macOS, `.lib` on Windows, etc) for projects
255+
which prefer statically linking.
256256

257257
There is a [crc-fast PHP extension](https://github.com/awesomized/crc-fast-php-ext) using it, for example.
258258

0 commit comments

Comments
 (0)