add linux stuff to pre-requisites (#6411)

This commit is contained in:
Danglewood
2024-05-14 09:08:18 -07:00
committed by GitHub
parent 8d060dc071
commit 05322de3b7

View File

@@ -28,6 +28,29 @@ Please refer to the [OpenBB Platform install documentation](/platform/installati
If the OpenBB Platform is not already installed, the `openbb-cli` package will install the default components.
:::
### Linux Requirements
Linux users will need to take additional steps prior to installation.
#### Rust
Rust and Cargo must be installed, system-level, and in the PATH. Follow the instructions on-screen to install and add to PATH in the shell profile.
```bash
curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh
```
#### Webkit
Next, install webkit.
- Debian-based / Ubuntu / Mint: `sudo apt install libwebkit2gtk-4.0-dev`
- Arch Linux / Manjaro: `sudo pacman -S webkit2gtk`
- Fedora: `sudo dnf install gtk3-devel webkit2gtk3-devel`
## PyPI
Within your existing OpenBB environment, install `openbb-cli` with:
@@ -36,7 +59,6 @@ Within your existing OpenBB environment, install `openbb-cli` with:
pip install openbb-cli
```
The installation script adds `openbb` to the PATH within your Python environment. The application can be launched from any path, as long as the environment is active.
```console