summaryrefslogtreecommitdiff
path: root/rust/examples/template/README.md
diff options
context:
space:
mode:
authorKyleMiles <krm504@nyu.edu>2021-06-29 11:35:06 -0400
committerKyleMiles <krm504@nyu.edu>2021-06-29 14:00:21 -0400
commit70be4645d30c8017524ae2b444ac7e0c0a8448a6 (patch)
tree3bdad671acaa346b2c893448fba7c4908363cfbd /rust/examples/template/README.md
parentf388a25624c5860c45f6e002577a2c283002ce47 (diff)
Rust API : No longer update to latest cargo nightly; Add link args back to -sys to reduce build errors
Diffstat (limited to 'rust/examples/template/README.md')
-rw-r--r--rust/examples/template/README.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/rust/examples/template/README.md b/rust/examples/template/README.md
index f10f89c8..998a9cd2 100644
--- a/rust/examples/template/README.md
+++ b/rust/examples/template/README.md
@@ -1,17 +1,19 @@
+# Template
+
[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
+## Plugins
Enable
```
[lib]
crate-type = ["cdylib"]
```
-in Cargo.toml`
-
-### Standalone executables
+in `Cargo.toml`.
-All standalone executables should call both `binaryninja::headless::init()` and `binaryninja::headless::shutdown()`.
+## Standalone executables
+All standalone executables should call both `binaryninja::headless::init()` and `binaryninja::headless::shutdown()` (see [`src/main.rs`](src/main.rs)).
+Standalone executables will fail to link if you do not provide a `build.rs`. The one provided here should work.