summaryrefslogtreecommitdiff
path: root/vendor/rustc-demangle/README.md
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-07-02 18:36:06 -0600
committermo khan <mo@mokhan.ca>2025-07-02 18:36:06 -0600
commit8cdfa445d6629ffef4cb84967ff7017654045bc2 (patch)
tree22f0b0907c024c78d26a731e2e1f5219407d8102 /vendor/rustc-demangle/README.md
parent4351c74c7c5f97156bc94d3a8549b9940ac80e3f (diff)
chore: add vendor directory
Diffstat (limited to 'vendor/rustc-demangle/README.md')
-rw-r--r--vendor/rustc-demangle/README.md57
1 files changed, 57 insertions, 0 deletions
diff --git a/vendor/rustc-demangle/README.md b/vendor/rustc-demangle/README.md
new file mode 100644
index 00000000..62cb80b0
--- /dev/null
+++ b/vendor/rustc-demangle/README.md
@@ -0,0 +1,57 @@
+# rustc-demangle
+
+Demangling for Rust symbols, written in Rust.
+
+[Documentation](https://docs.rs/rustc-demangle)
+
+## Usage
+
+You can add this as a dependency via your `Cargo.toml`
+
+```toml
+[dependencies]
+rustc-demangle = "0.1"
+```
+
+and then be sure to check out the [crate
+documentation](https://docs.rs/rustc-demangle) for usage.
+
+## Usage from non-Rust languages
+
+You can also use this crate from other languages via the C API wrapper in the
+`crates/capi` directory. This can be build with:
+
+```sh
+$ cargo build -p rustc-demangle-capi --release
+```
+
+You'll then find `target/release/librustc_demangle.a` and
+`target/release/librustc_demangle.so` (or a different name depending on your
+platform). These objects implement the interface specified in
+`crates/capi/include/rustc_demangle.h`.
+
+If your build system does not support Rust, there is also a mostly-identical
+C version in the `crates/native-c` which you can use via copy-paste or as
+a git submodule. Read `crates/native-c/README.md` for more details. It is
+likely to be less supported than the Rust version, so it is better to use
+the Rust version if your build system supports it.
+
+Both the Rust and C versions don't require memory allocation or any other
+operating-system support.
+
+# License
+
+This project is 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 rustc-demangle you, as defined in the Apache-2.0 license, shall
+be dual licensed as above, without any additional terms or conditions.