adding readme, arm-syscall, bin-info, and breakpoint plugins

1 files changed, 39 insertions, 0 deletions

diff --git a/python/examples/README.md b/python/examples/README.md
new file mode 100644
index 00000000..4ad4ac03
--- /dev/null
+++ b/python/examples/README.md
@@ -0,0 +1,39 @@
+# Binary Ninja Python API Examples
+
+The following examples demonstrate the Binary Ninja API. They include both stand-alone examples that directly call into the core, as well as examples meant to be loaded as plugins.
+
+## Stand-alone
+
+* bin-info.py - general binary information
+* arm-syscall.py - extract syscall numbers from IL for arm Mach-O files
+
+To use the stand-alone Python examples, make sure your `PYTHON_PATH` includes the API, like:
+
+```
+PYTHONPATH=$PYTHONPATH:/Applications/Binary\ Ninja.app/Contents/Resources/python
+```
+
+## GUI Plugins
+
+* nes.py - 6502 CPU architecture including LLIL lifting and `.NES` file format parser
+* breakpoint.py - small example showing how to modify a file and register a GUI menu item
+
+Plugins are meant to be loaded into a running Binary Ninja GUI and should either be copied or symlinked into the appropriate plugin folder. You'll need to then re-start Binary Ninja.
+
+### OSX
+
+```
+~/Library/Application Support/Binary Ninja/plugins
+```
+
+### Windows
+
+```
+%APPDATA%\Binary Ninja\plugins
+```
+
+### Linux
+
+```
+~/.binaryninja/plugins
+```