summaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2023-04-26 18:56:15 -0400
committerJordan Wiens <jordan@psifertex.com>2023-04-26 18:56:36 -0400
commit6466fba3341b2ea7dbfceeeebbc6c0322a5d8514 (patch)
tree4e29746cbd3f831cf0090a18dae065e23bce561c /docs/guide
parent2dfa49099f3119fef1ba7aae28c72e4e442e240f (diff)
update python dependency documentation
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/index.md2
-rw-r--r--docs/guide/plugins.md6
2 files changed, 5 insertions, 3 deletions
diff --git a/docs/guide/index.md b/docs/guide/index.md
index c8396b89..6865ce9b 100644
--- a/docs/guide/index.md
+++ b/docs/guide/index.md
@@ -50,7 +50,7 @@ The following files and folders may be created in the user folder but are not cr
- `keybindings.json`: Custom key bindings (see [key bindings](#custom-hotkeys))
- `startup.py`: Default python commands run once the UI is loaded in the context of the scripting console
- `signatures/`: Any user-created signatures can be stored in platform-specific subfolders in this location
-- `pythonVER/`: Any pip dependencies from plugin manager plugins are installed to the appropriate python version subfolder such as `python310`
+- `pythonVER/`: Any pip dependencies from plugin manager plugins are installed to the appropriate python version subfolder such as `python310`, or `python311`
- `symbols/`: Used to store automatically downloaded PDBs
- `update/`: Used to store update caches for pending updates
- `snippets/`: Used to store snippets created using the official Snippet plugin
diff --git a/docs/guide/plugins.md b/docs/guide/plugins.md
index d047666c..e7e8ec48 100644
--- a/docs/guide/plugins.md
+++ b/docs/guide/plugins.md
@@ -87,9 +87,11 @@ Then just restart and the newly-enabled plugin will be loaded.
Binary Ninja can automatically install pip requirements for python plugins installed using the plugin manager. If the plugin author has included a `requirements.txt` file, the plugin manager will automatically install those dependencies.
-Binary Ninja ship with an embedded version of Python on Windows and macOS. Instead of installing pip plugins inside that Python, we recommend installing an official version from [python.org](https://www.python.org/downloads/windows/) (NOTE: ensure you do not accidentally install a 32-bit build) or a [homebrew](https://docs.brew.sh/Homebrew-and-Python) Python 3.x build. Binary Ninja currently requires a version of Python 3.7 or greater, though 3.10 or newer is preferred (and may be required by some plugins).
+The `Install python3 module` action (available from the [command palette](index.md#command-palette)) can be used to install python3 modules to the local [python folder](index.md#user-folder).
-Then you can adjust your [python.interpreter setting](settings.md#python.interpreter) to point to the appropriate install location. Note that the file being pointed to should be a `.dll` or `.dylib` though homebrew will often install libraries without any extension. For example:
+Binary Ninja ships with an embedded version of Python on Windows and macOS. On Linux, default Python paths and versions are used instead. All plugin dependencies installed are placed in the [user folder](index.md#user-folder) / pythonVER. For example on Linux with Python 3.10: `~/.binaryninja/python310/`.
+
+You may also wish to use your own custom interpreter which you can set with the [python.interpreter setting](settings.md#python.interpreter) to point to the appropriate install location. Note that the file being pointed to should be a `.dll`, `.dylib`, or `.so` though homebrew will often install libraries without any extension. For example:
```
$ file /usr/local/Cellar/python@3.8/3.8.5/Frameworks/Python.framework/Versions/3.8/Python