Resolves #2521; Rust API Linking Errors

1 files changed, 17 insertions, 0 deletions

diff --git a/rust/examples/template/README.md b/rust/examples/template/README.md
new file mode 100644
index 00000000..f10f89c8
--- /dev/null
+++ b/rust/examples/template/README.md
@@ -0,0 +1,17 @@
+[The only official method of providing linker arguments to a crate is through that crate's `build.rs`](https://github.com/rust-lang/cargo/issues/9554), thus this template.
+
+Please see `Cargo.toml` for further configuration options.
+
+### Plugins
+
+Enable
+```
+[lib]
+crate-type = ["cdylib"]
+```
+in  Cargo.toml`
+
+### Standalone executables
+
+All standalone executables should call both `binaryninja::headless::init()` and `binaryninja::headless::shutdown()`.
+