You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: rust/README.md
+11-8Lines changed: 11 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -11,9 +11,9 @@ Official Rust bindings for [Binary Ninja].
11
11
12
12
These bindings are still actively under development. Compatibility _will_ break and conventions _will_ change!
13
13
It is encouraged that you reference a specific commit to avoid having your plugin/application break when the API changes.
14
-
To specify a specific commit see the cargo documentation [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choice-of-commit).
14
+
To specify a specific commit, see the cargo documentation [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choice-of-commit).
15
15
16
-
If you are worried about breaking changes avoid modules with warnings about instability!
16
+
If you are worried about breaking changes, avoid modules with warnings about instability!
17
17
18
18
**MSRV**: The Rust version specified in the `Cargo.toml`.
19
19
@@ -53,7 +53,7 @@ More examples can be found in [here](https://github.com/Vector35/binaryninja-api
53
53
### Link to Binary Ninja
54
54
55
55
Writing a standalone executable _or_ a plugin requires that you link to `binaryninjacore` directly. The process of locating that however
56
-
is done for you within the `binaryninjacore-sys` crate. Because linker arguments are _not_ transitive for executables you
56
+
is done for you within the `binaryninjacore-sys` crate. Because linker arguments are _not_ transitive for executables, you
57
57
must specify them within your `build.rs`.
58
58
59
59
`Cargo.toml`:
@@ -109,7 +109,7 @@ Examples for writing a plugin can be found [here](https://github.com/Vector35/bi
109
109
110
110
### Write a Standalone Executable
111
111
112
-
If you have a headless supporting license you are able to use Binary Ninja as a regular dynamically loaded library.
112
+
If you have a headless supporting license, you are able to use Binary Ninja as a regular dynamically loaded library.
113
113
114
114
Standalone executables must initialize the core themselves. `binaryninja::headless::init()` to initialize the core, and
115
115
`binaryninja::headless::shutdown()` to shutdown the core. Prefer using `binaryninja::headless::Session` as it will
@@ -140,14 +140,14 @@ If you're thinking of contributing to the Rust API, we encourage you to join the
140
140
141
141
### Testing
142
142
143
-
When contributing new APIs or refactoring existing APIs it is vital that you test your code! If you do not have a
144
-
headless supported license you should still be able to write them and open your PR. Once open a
143
+
When contributing new APIs or refactoring existing APIs, it is vital that you test your code! If you do not have a
144
+
headless supported license, you should still be able to write them and open your PR. Once open, a
145
145
maintainer will approve tests to run and from there you can refine the test so that it passes in CI.
146
146
147
147
### Documentation
148
148
149
-
When refactoring or making new changes make sure that the documentation for the respective APIs is up-to-date and not missing.
150
-
Much of the APIs documentation exists only in the python bindings, so use that as a guide. If there is an API that confuses you
149
+
When refactoring or making new changes, make sure that the documentation for the respective APIs is up to date and not missing.
150
+
Much of the APIs documentation exists only in the python bindings, so use that as a guide. If there is an API that confuses you,
151
151
it will likely confuse someone else, and you should make an issue or ask for guidance in the Slack channel above.
0 commit comments