Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention wasm-features in Readme.md #167

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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"] }
```

Glitchy-Tozier marked this conversation as resolved.
Show resolved Hide resolved
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