Follow along with the instructions of the video or use the steps below to use the OpenBB SDK:
+ + + ### 1. **Install [Miniconda](https://docs.conda.io/en/latest/miniconda.html)** Download the `x86_64` Miniconda for your respective system and follow along diff --git a/website/content/terminal/quickstart/installation.md b/website/content/terminal/quickstart/installation.md index b37901cb90c7..33da8db6bec2 100644 --- a/website/content/terminal/quickstart/installation.md +++ b/website/content/terminal/quickstart/installation.md @@ -7,21 +7,25 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import InstallerButton from "@site/src/components/General/InstallerButton"; -The OpenBB Terminal can be directly installed on your computer via our installation program. Within this section, you are guided through the installation process and how to launch the program. If you struggle with the installation process, please don’t hesitate to reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). +The OpenBB Terminal can be directly installed on your computer via our installation programs. Within this section, you are guided through the installation process and how to launch the program. If you struggle with the installation process, please don’t hesitate to reach us on [Discord](https://openbb.co/discord) or visit our [contact page](https://openbb.co/contact). -OpenBB Terminal is available in all major platforms. With MacOS/Windows you can easily install with the installer (instructions below). It is also available to install on Linux with Docker or from source. +OpenBB Terminal is available on all major platforms. With Windows and macOS you can make use of an installation file as found below. Furthermore, it is also possible to install the OpenBB Terminal with Docker or directly through Python which also offers support for Linux. :::info Installation InstructionsThis section provides you with the installation file as well as the guide to install the OpenBB Terminal via Windows.
Download the installer from the button below:
When the file is downloaded, use the following steps to run the OpenBB Terminal:
+Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
+ + +When the DMG file is downloaded, use the following steps to run the OpenBB Terminal:
+Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
+ + +Open. You will see a message saying
Install with Docker
+Installing the OpenBB Terminal via Docker supports both Windows and Unix systems (Linux + MacOS). Installation differs a bit between operating system (Windows, macOS and Linux). Please select the section matching to your OS. +
-Here we will detail how to run OpenBB Terminal Docker image. +Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
+ + -Please check the section matching to your OS. ## 1. Windows @@ -228,7 +237,11 @@ docker run --rm -it \This section guides you a long to install the OpenBB Terminal via Python. This installation type supports both Windows and Unix systems (Linux + MacOS).
+ +Follow along with the instructions of the video or use the steps below to run the OpenBB Terminal:
+ + **NOTE for Windows users:** For Windows users who prefer to use an environment similar to what Linux and macOS users use, we recommend Windows Subsystem for Linux (WSL). WSL emulates a Linux machine inside your Windows system. If this is the case - jump to the Installing WSL (Only for Windows users) section before proceeding. diff --git a/website/package-lock.json b/website/package-lock.json index 075a37a07d8e..3af309d434ac 100644 --- a/website/package-lock.json +++ b/website/package-lock.json @@ -1,12 +1,12 @@ { "name": "docs", - "version": "0.0.0", + "version": "1.0.0", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "docs", - "version": "0.0.0", + "version": "1.0.0", "dependencies": { "@cmfcmf/docusaurus-search-local": "^0.11.0", "@docusaurus/core": "2.2.0", diff --git a/website/yarn.lock b/website/yarn.lock index 302e6e7ba3ca..91e018547d05 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -4299,6 +4299,11 @@ "resolved" "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz" "version" "1.0.0" +"fsevents@~2.3.2": + "integrity" "sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==" + "resolved" "https://registry.npmjs.org/fsevents/-/fsevents-2.3.2.tgz" + "version" "2.3.2" + "function-bind@^1.1.1": "integrity" "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==" "resolved" "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz"