Move platform submodules into API

1 files changed, 23 insertions, 0 deletions

diff --git a/platform/freebsd/README.md b/platform/freebsd/README.md
new file mode 100644
index 00000000..ecef4b19
--- /dev/null
+++ b/platform/freebsd/README.md
@@ -0,0 +1,23 @@
+# platform-freebsd
+This is the FreeBSD platform 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 `libplatform_freebsd.so`,
+`libplatform_freebsd.dylib` or `platform_freebsd.dll` depending on your platform.
+
+To install the plugin, first launch Binary Ninja and uncheck the "FreeBSD platform 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.**