summaryrefslogtreecommitdiff
path: root/docs/getting-started.md
diff options
context:
space:
mode:
authorJordan Wiens <jordan@psifertex.com>2024-01-06 20:14:36 -0500
committerJordan Wiens <jordan@psifertex.com>2024-01-06 20:14:36 -0500
commit869785ff2ee9b83731b9f8451f8aa4372d74c31e (patch)
treedc12bc132e49f088484cf27fecb5b793b3ef2844 /docs/getting-started.md
parent7590260227210922004430036205744083351785 (diff)
clarify linux and demo setup
Diffstat (limited to 'docs/getting-started.md')
-rw-r--r--docs/getting-started.md4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/getting-started.md b/docs/getting-started.md
index 4d222a87..2b5e4c84 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -6,9 +6,11 @@ Welcome to Binary Ninja. This introduction document is meant to quickly guide yo
## Installing Binary Ninja
The download links you receive after purchasing expire after 72 hours but as long as you have [active support](https://binary.ninja/faq/#updates) you can [request download links](https://binary.ninja/recover/) any time!
+
### Linux
-Because Linux install locations can vary widely, we do not assume that Binary Ninja has been installed in any particular folder on Linux. Instead, first unzip the installation zip wherever you wish to install BN, and then run `binaryninja/scripts/linux-setup.sh`. This sets up file associations, icons, and adds BN's Python library to your python path. Run it with `-h` to see the customization options.
+Because Linux install locations can vary widely, we do not assume that Binary Ninja has been installed in any particular folder on Linux. Instead, first unzip the installation zip wherever you wish to install BN. Next, for paid versions, run `./binaryninja/scripts/linux-setup.sh`. This sets up file associations, icons, and adds BN's Python library to your python path. Adding the library to your path is most helpful for headless functionality in commercial licenses, but even on non-commercial plugins it can help IDE's find the type information to make plugin development easier. Run the script with `-h` to see customization options.
+
### MacOS
To install on MacOS, simply drag-and-drop the app bundle from the DMG to the desired location.