From 3501dd765d8ad917fb60b72f2e6983ed76eb31bc Mon Sep 17 00:00:00 2001 From: Jordan Wiens Date: Tue, 23 May 2017 20:48:42 -0400 Subject: basic plugin usage --- docs/getting-started.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) (limited to 'docs/getting-started.md') diff --git a/docs/getting-started.md b/docs/getting-started.md index dbc99ae3..53aba268 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -14,6 +14,10 @@ Once the license key is installed, you can change it, back it up, or otherwise i - Linux: `~/.binaryninja` - Windows: `%APPDATA%\Binary Ninja` +## Linux Setup + +Because linux install locations can vary widely, we do not assume a Binary Ninja has been installed in any particular folder on linux. Rather, you can simply run `binaryninja/scripts/linux-setup.sh` after extracting the zip and various file associations, icons, and other settings will be set up. Run it with `-h` to see the customization options. + ## Loading Files You can load files in many ways: @@ -186,6 +190,16 @@ Note !!! Tip "Note" The current script console only supports Python at the moment, but it's fully extensible for other programming languages for advanced users who with to implement their own bindings. +## Using Plugins + +Plugins can be installed by one of two methods. First, they can be manually installed by adding the plugin (either a `.py` file or a folder implementing a python module with a `__init__.py` file) to the appropriate path: + +- OS X: `~/Library/Application Support/Binary Ninja/plugins/` +- Linux: `~/.binaryninja/plugins/` +- Windows: `%APPDATA%\Binary Ninja\plugins` + +Alternatively, plugins can be installed with the new [pluginmanager](https://api.binary.ninja/binaryninja.pluginmanager-module.html) API. + ## Preferences/Updates ![preferences >](/images/preferences.png "Preferences") -- cgit v1.3.1