summaryrefslogtreecommitdiffstats
path: root/third_party/rust/libm/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/rust/libm/README.md
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/rust/libm/README.md')
-rw-r--r--third_party/rust/libm/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/third_party/rust/libm/README.md b/third_party/rust/libm/README.md
new file mode 100644
index 0000000000..b864b5df8e
--- /dev/null
+++ b/third_party/rust/libm/README.md
@@ -0,0 +1,51 @@
+# `libm`
+
+A port of [MUSL]'s libm to Rust.
+
+[MUSL]: https://musl.libc.org/
+
+## Goals
+
+The short term goal of this library is to [enable math support (e.g. `sin`, `atan2`) for the
+`wasm32-unknown-unknown` target][wasm] (cf. [rust-lang/compiler-builtins][pr]). The longer
+term goal is to enable [math support in the `core` crate][core].
+
+[wasm]: https://github.com/rust-lang/libm/milestone/1
+[pr]: https://github.com/rust-lang/compiler-builtins/pull/248
+[core]: https://github.com/rust-lang/libm/milestone/2
+
+## Already usable
+
+This crate is [on crates.io] and can be used today in stable `#![no_std]` programs.
+
+The API documentation can be found [here](https://docs.rs/libm).
+
+[on crates.io]: https://crates.io/crates/libm
+
+## Benchmark
+[benchmark]: #benchmark
+
+The benchmarks are located in `crates/libm-bench` and require a nightly Rust toolchain.
+To run all benchmarks:
+
+> cargo +nightly bench --all
+
+## Contributing
+
+Please check [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## License
+
+Licensed under either of
+
+- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
+ http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
+
+at your option.
+
+### Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the
+work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
+additional terms or conditions.