diff options
| author | Jordan Wiens <jordan@psifertex.com> | 2017-08-21 21:54:23 -0500 |
|---|---|---|
| committer | Jordan Wiens <jordan@psifertex.com> | 2017-08-21 21:54:23 -0500 |
| commit | 207640bcbc5d0ee8639c2b6de0bef9e3c4eadeeb (patch) | |
| tree | 0f22a95a004b369e513d7261d80becb47e9397a8 /docs/getting-started.md | |
| parent | d38a8d23d331c464e6d5089000ebf641ef855110 (diff) | |
updated docs
Diffstat (limited to 'docs/getting-started.md')
| -rw-r--r-- | docs/getting-started.md | 39 |
1 files changed, 32 insertions, 7 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md index 46dee008..d91eb046 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -2,18 +2,45 @@ Welcome to Binary Ninja. This introduction document is meant to quickly guide you over some of the most common uses of Binary Ninja. - +## Directories -## License +Binary Ninja uses two main locations. The first is the install path of the binary itself and the second is the user folders for user-installed content. -When you first run Binary Ninja, it will prompt you for your license key. You should have received your license key via email after your purchase. If not, please contact [support]. +### Binary Path + +Binaries are installed in the following locations by default: + +- OS X: `/Applications/Binary Ninja.app` +- Windows: `C:\Program Files\Vector35\BinaryNinja` +- Linux: Wherever you extract it! (No standard location) -Once the license key is installed, you can change it, back it up, or otherwise inspect it simply by looking in: +!!! Warning "Warning" + Do not put any user content in the install-path of Binary Ninja. The auto-update process of Binary Ninja may replace any files included in these folders. + +### User Folder + +The base locations of user folders are: - OS X: `~/Library/Application Support/Binary Ninja` - Linux: `~/.binaryninja` - Windows: `%APPDATA%\Binary Ninja` +Contents of the user folder includes: + +- `settings.json`: Advanced settings (see [settings](#settings)) +- `lastrun`: A text file containing the directory of the last BinaryNinja binary path -- very useful for plugins to resolve the install locations in non-default settings or on linux. +- `plugins/`: Folder containing all manually installed user plugins +- `repositories/`: Folder containing files and plugins managed by the [Plugin Manager API](https://api.binary.ninja/binaryninja.pluginmanager-module.html) + + + +## License + +When you first run Binary Ninja, it will prompt you for your license key. You should have received your license key via email after your purchase. If not, please contact [support]. + +Once the license key is installed, you can change it, back it up, or otherwise inspect it simply by looking inside the base of the user folder for `license.dat`. + + ## 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. @@ -252,6 +279,4 @@ Below is an example `settings.json` setting various options: ``` ## Getting Support -Vector 35 offers a number of ways to get Binary Ninja [support]. - -[support]: https://binary.ninja/support/ +Vector 35 offers a number of ways to get Binary Ninja [support](https://binary.ninja/support/). |