From e093c21ed880ac3eb72119be15093ee04f8ce299 Mon Sep 17 00:00:00 2001 From: Rusty Wagner Date: Tue, 5 Mar 2024 19:50:13 -0500 Subject: Move architecture modules into the API repo --- arch/mips/README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100644 arch/mips/README.md (limited to 'arch/mips/README.md') diff --git a/arch/mips/README.md b/arch/mips/README.md new file mode 100644 index 00000000..d1400a6a --- /dev/null +++ b/arch/mips/README.md @@ -0,0 +1,19 @@ +# arch-mips + +This is the MIPS architecture plugin that ships with Binary Ninja. + +## Building + +Building the architecture plugin requires `cmake` 3.9 or above. You will also need the [Binary Ninja API source](https://github.com/Vector35/binaryninja-api). + +Run `cmake`. This can be done either from a separate build directory or from the source directory. Once that is complete, run `make` in the build directory to compile the plugin. + +The plugin can be found in the root of the build directory as `libarch_mips.so`, `libarch_mips.dylib` or `arch_mips.dll` depending on your platform. + +To install the plugin, first launch Binary Ninja and uncheck the "MIPS architecture plugin" option in the "Core Plugins" section. This will cause Binary Ninja to stop loading the bundled plugin so that its replacement can be loaded. Once this is complete, you can copy the plugin into the user plugins directory (you can locate this by using the "Open Plugin Folder" option in the Binary Ninja UI). + +**Do not replace the architecture plugin in the Binary Ninja install directory. This will be overwritten every time there is a Binary Ninja update. Use the above process to ensure that updates do not automatically uninstall your custom build.** + +## Pull Requests + +Please follow whatever formatting conventions are present in the file you edit. Pay attention to curly brackets, spacing, tabs vs. spaces, etc. -- cgit v1.3.1