Skip to content

Commit

Permalink
More rust documentation changes
Browse files Browse the repository at this point in the history
  • Loading branch information
emesare committed Jan 15, 2025
1 parent d282bde commit 606b584
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions rust/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,11 @@ fn main() {
### Requirements

- Having BinaryNinja installed (and your license registered)
- For headless operation you must have a headless supporting license.
- Clang
- Rust

### To link to Binary Ninja
### Link to Binary Ninja

Writing a standalone executable _or_ a plugin requires that you link to `binaryninjacore` directly. The process of locating that however
is done for you within the `binaryninjacore-sys` crate. Because linker arguments are _not_ transitive for executables you
Expand Down Expand Up @@ -78,7 +79,7 @@ fn main() {
}
```

### To write a plugin:
### Write a Plugin

Plugins are loaded at runtime and as such will have their own initialization routine.

Expand All @@ -100,7 +101,7 @@ pub extern "C" fn CorePluginInit() -> bool {
}
```

### To write a standalone executable:
### Write a Standalone Executable

If you have a headless supporting license you are able to use Binary Ninja as a regular dynamically loaded library.

Expand Down

0 comments on commit 606b584

Please sign in to comment.