From 80dabc17fce528b809df30621571039eb8979bf0 Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Mon, 24 Apr 2023 19:32:25 +0200 Subject: [PATCH] Update installation docs for release (#4876) * Point download links to main * Fix markdown formatting * Remove debug echo from mac launcher script * Update macos pkg installation instructions * Fix image links --- .../OpenBB Terminal/OpenBB Terminal | 2 +- website/content/terminal/installation/docker.md | 2 ++ website/content/terminal/installation/macos.md | 13 ++++++++----- website/content/terminal/installation/pypi.md | 2 +- 4 files changed, 12 insertions(+), 7 deletions(-) diff --git a/build/pyinstaller/macOS_package_assets/OpenBB Terminal/OpenBB Terminal b/build/pyinstaller/macOS_package_assets/OpenBB Terminal/OpenBB Terminal index bef482647c6..cec491e5f10 100755 --- a/build/pyinstaller/macOS_package_assets/OpenBB Terminal/OpenBB Terminal +++ b/build/pyinstaller/macOS_package_assets/OpenBB Terminal/OpenBB Terminal @@ -1,6 +1,6 @@ #!/bin/bash -echo "1" +clear SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )" diff --git a/website/content/terminal/installation/docker.md b/website/content/terminal/installation/docker.md index 67a7eddc62c..0a93adfbff9 100644 --- a/website/content/terminal/installation/docker.md +++ b/website/content/terminal/installation/docker.md @@ -89,6 +89,7 @@ This file contents the settings to pull and run OpenBB Terminal Docker image. + **Install Docker Desktop** You can find `Docker Desktop` for MacOS here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) @@ -167,6 +168,7 @@ This file contents the settings to pull and run OpenBB Terminal Docker image. The `xhost +$IP` and `DISPLAY=$IP:0` parts are there to allow charts display. + **Install Docker Desktop** You can find `Docker Desktop` for Linux here: [Download Docker Desktop](https://www.docker.com/products/docker-desktop) diff --git a/website/content/terminal/installation/macos.md b/website/content/terminal/installation/macos.md index 0ad0b32db47..3532ba09836 100644 --- a/website/content/terminal/installation/macos.md +++ b/website/content/terminal/installation/macos.md @@ -60,13 +60,16 @@ To understand whether you are using an Apple Sillicon (M1) device or an Intel-ba Step by step instructions: -1. Download the DMG file from the links above. -2. Mount the downloaded DMG file by double-clicking on it. -3. Click and drag the OpenBB Terminal folder and hold it over the Applications shortcut. This opens a new Finder window, then drag the OpenBB Terminal folder into the Applications folder. +1. Download the PKG file from the links above. -![MacOS Installation](https://user-images.githubusercontent.com/11668535/173027899-9b25ae4f-1eef-462c-9dc9-86086e9cf197.png) +2. Launch the PKG installer by double-clicking on it. +image -4. Unmount the installer, by "Ejecting OpenBB Terminal" from, locations, in Finder. +3. Follow the Installer prompt. You will be asked to enter your system password. +image + +4. This process installs the application into the `/Application/OpenBB Terminal` folder. +image 5. Launch the application by double-clicking on the `OpenBB Terminal` application. If everything was successful you should see a screen like the one below: diff --git a/website/content/terminal/installation/pypi.md b/website/content/terminal/installation/pypi.md index efcf1672e18..cf734b5d651 100644 --- a/website/content/terminal/installation/pypi.md +++ b/website/content/terminal/installation/pypi.md @@ -182,7 +182,7 @@ Create the environment using a configuration file from the OpenBB Terminal repos Copy and paste these commands into the terminal/command prompt: ```shell -conda env create -n obb --file https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/d19412933245b51643a9e7f2624f1d42907488f4/build/conda/conda-3-9-env.yaml +conda env create -n obb --file https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/main/build/conda/conda-3-9-env.yaml ``` Agree to the prompts if there are any.