Skip to content

Commit

Permalink
Mention wasm-features in Readme.md and documentation (#167)
Browse files Browse the repository at this point in the history
  • Loading branch information
Glitchy-Tozier authored Jan 2, 2022
1 parent 54b7458 commit 8bc447f
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 2 deletions.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,9 @@ Add this to your `Cargo.toml`:
argmin = "0.4.7"
```

### Optional features (recommended)
### Optional features

#### Recommended features

There are additional features which can be activated in `Cargo.toml`:

Expand All @@ -106,6 +108,20 @@ BLAS backend in the `Cargo.toml`:
ndarray-linalg = { version = "*", features = ["intel-mkl-static"] }
```

#### Experimental support for compiling to WebAssembly

When compiling to WASM, one of the following features must be used:

```toml
argmin = { version = "0.4.7", features = ["wasm-bindgen"] }
```

```toml
argmin = { version = "0.4.7", features = ["stdweb"] }
```

Note that WASM support is still experimental. Please report any issues you encounter when compiling argmin to WASM.

### Running the tests and building the examples

Running the tests requires the `ndarrayl` and feature to be enabled:
Expand Down
18 changes: 17 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,9 @@
//! argmin = "0.4.7"
//! ```
//!
//! ## Optional features (recommended)
//! ## Optional features
//!
//! ### Recommended features
//!
//! There are additional features which can be activated in `Cargo.toml`:
//!
Expand All @@ -106,6 +108,20 @@
//! ndarray-linalg = { version = "*", features = ["intel-mkl-static"] }
//! ```
//!
//! ### Experimental support for compiling to WebAssembly
//!
//! When compiling to WASM, one of the following features must be used:
//!
//! ```toml
//! argmin = { version = "0.4.7", features = ["wasm-bindgen"] }
//! ```
//!
//! ```toml
//! argmin = { version = "0.4.7", features = ["stdweb"] }
//! ```
//!
//! Note that WASM support is still experimental. Please report any issues you encounter when compiling argmin to WASM.
//!
//! ## Running the tests and building the examples
//!
//! Running the tests requires the `ndarrayl` and feature to be enabled:
Expand Down

0 comments on commit 8bc447f

Please sign in to comment.