Move view modules into the API repo

1 files changed, 30 insertions, 0 deletions

diff --git a/view/macho/README.md b/view/macho/README.md
new file mode 100644
index 00000000..b94ca4b3
--- /dev/null
+++ b/view/macho/README.md
@@ -0,0 +1,30 @@
+# view-macho
+This is the Mach-O view plugin that ships with Binary Ninja.
+
+## Issues
+
+Issues for this repository have been disabled. Please file an issue for this repository at https://github.com/Vector35/binaryninja-api/issues. All previously existing issues for this repository have been transferred there as well.
+
+## 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` (or `ninja`, depending on your default generator) in the build directory to compile the plugin.
+
+The plugin can be found in the root of the build directory as `libview_macho.so`,
+`libview_macho.dylib` or `view_macho.dll` depending on your platform.
+
+To install the plugin, first launch Binary Ninja and uncheck the "Mach-O view 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, run `make install` (or `ninja install`, depending on the generator used).
+
+You can also manually 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 view 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.**