Skip to content

Commit

Permalink
Add features section to README
Browse files Browse the repository at this point in the history
This section is now very small, and doesn't clutter anything.
  • Loading branch information
JSorngard committed Oct 11, 2024
1 parent cb536ff commit 28a4efb
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,17 @@ let z = 2.0 * f64::ln(2.0);
assert_abs_diff_eq!(z.lambert_w0(), f64::ln(2.0));
```

## Features

One of the below features must be enabled:

`libm` *(enabled by default)*: if the `std` feature is disabled,
this feature uses the [`libm`](https://crates.io/crates/libm) crate to compute
square roots and logarithms during function evaluation instead of the standard library.

`std`: use the standard library to compute square roots and logarithms for a
potential performance gain. When this feature is disabled the crate is `no_std` compatible.

## License

Licensed under either of
Expand Down

0 comments on commit 28a4efb

Please sign in to comment.