diff --git a/README.md b/README.md index ef94952855b..ec2412a04d2 100644 --- a/README.md +++ b/README.md @@ -16,24 +16,24 @@ [![Bugs Open][bugs-open-shield]][bugs-open-url] [![Bugs Closed][bugs-closed-shield]][bugs-closed-url] -[![Build Status](https://github.com/GamestonkTerminal/GamestonkTerminal/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/GamestonkTerminal/GamestonkTerminal/actions) +[![Build Status](https://github.com/OpenBB-finance/OpenBBTerminal/actions/workflows/test.yml/badge.svg?branch=master)](https://github.com/OpenBB-finance/OpenBBTerminal/actions) [![Documentation Status](https://readthedocs.org/projects/gamestonk-terminal/badge/?version=latest)](https://gamestonk-terminal.readthedocs.io/?badge=latest) -[![GitHub release](https://img.shields.io/github/release/GamestonkTerminal/GamestonkTerminal.svg?maxAge=3600)](https://github.com/GamestonkTerminal/GamestonkTerminal/releases) +[![GitHub release](https://img.shields.io/github/release/OpenBB-finance/OpenBBTerminal.svg?maxAge=3600)](https://github.com/OpenBB-finance/OpenBBTerminal/releases) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/GamestonkTerminal/GamestonkTerminal/main)](https://www.tickgit.com/browse?repo=github.com/GamestonkTerminal/GamestonkTerminal&branch=main) +[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/OpenBB-finance/OpenBBTerminal/main)](https://www.tickgit.com/browse?repo=github.com/OpenBB-finance/OpenBBTerminal&branch=main) ![Discord Shield](https://discordapp.com/api/guilds/831165782750789672/widget.png?style=shield) -[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/gamestonkt.svg?style=social&label=Follow%20%40gamestonkt)](https://twitter.com/gamestonkt) +[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/openbb_finance.svg?style=social&label=Follow%20%40openbb_finance)](https://twitter.com/openbb_finance)

- - Logo + + Logo

OpenBB Terminal 🚀

-

Click on the gif below for a DEMO of the terminal.

+

Click on the GIF below for a DEMO of the terminal.

@@ -44,19 +44,19 @@

Investment research for everyone.
- ≪ GETTING STARTED + ≪ GETTING STARTED   ·   - + SEE FEATURES »

- + Report Bug · - + Suggest Improvement · - + Request a Feature

@@ -66,6 +66,7 @@

Table of Contents
  1. About The Project
    2. +
  2. Installation
  3. Contributing
  4. License
  5. Disclaimer
    6. @@ -124,11 +125,11 @@ go up. Recommended if you adopted a strategy of buying high and selling low. -We are interested in your view on what sort of [features](https://github.com/GamestonkTerminal/GamestonkTerminal/issues) +We are interested in your view on what sort of [features](https://github.com/OpenBB-finance/OpenBBTerminal/issues) would make you buy even higher and selling even lower. Also, if somehow you're sitting in several mils due to this terminal, don't forget to report a -[bug](https://github.com/GamestonkTerminal/GamestonkTerminal/issues) so that the team can fix, and keep the old ways. +[bug](https://github.com/OpenBB-finance/OpenBBTerminal/issues) so that the team can fix, and keep the old ways. **Join the 🙌 💎 Gang** @@ -139,7 +140,7 @@ Welcome to the club, and feel free to support the developers behind this amazing ## License Distributed under the MIT License. See -[LICENSE](https://github.com/GamestonkTerminal/GamestonkTerminal/blob/main/LICENSE) for more information. +[LICENSE](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE) for more information. ## Disclaimer @@ -164,12 +165,12 @@ any loss or damage as a result of your trading, or your reliance on the informat Feel free to share loss porn, memes or any questions at: - Discord: -- Twitter: [@gamestonkt](https://twitter.com/gamestonkt) +- Twitter: [@openbb_finance](https://twitter.com/openbb_finance) ### Contributors - - + + ## Acknowledgments @@ -188,19 +189,19 @@ Feel free to share loss porn, memes or any questions at: -[contributors-shield]: https://img.shields.io/github/contributors/GamestonkTerminal/GamestonkTerminal.svg?style=for-the-badge -[contributors-url]: https://github.com/GamestonkTerminal/GamestonkTerminal/graphs/contributors -[forks-shield]: https://img.shields.io/github/forks/GamestonkTerminal/GamestonkTerminal.svg?style=for-the-badge -[forks-url]: https://github.com/GamestonkTerminal/GamestonkTerminal/network/members -[stars-shield]: https://img.shields.io/github/stars/GamestonkTerminal/GamestonkTerminal.svg?style=for-the-badge -[stars-url]: https://github.com/GamestonkTerminal/GamestonkTerminal/stargazers -[issues-shield]: https://img.shields.io/github/issues/GamestonkTerminal/GamestonkTerminal.svg?style=for-the-badge&color=blue -[issues-url]: https://github.com/GamestonkTerminal/GamestonkTerminal/issues -[bugs-open-shield]: https://img.shields.io/github/issues/GamestonkTerminal/GamestonkTerminal/bug.svg?style=for-the-badge&color=yellow -[bugs-open-url]: https://github.com/GamestonkTerminal/GamestonkTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aopen -[bugs-closed-shield]: https://img.shields.io/github/issues-closed/GamestonkTerminal/GamestonkTerminal/bug.svg?style=for-the-badge&color=success -[bugs-closed-url]: https://github.com/GamestonkTerminal/GamestonkTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed -[license-shield]: https://img.shields.io/github/license/GamestonkTerminal/GamestonkTerminal.svg?style=for-the-badge -[license-url]: https://github.com/GamestonkTerminal/GamestonkTerminal/blob/main/LICENSE.txt +[contributors-shield]: https://img.shields.io/github/contributors/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge +[contributors-url]: https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge +[forks-url]: https://github.com/OpenBB-finance/OpenBBTerminal/network/members +[stars-shield]: https://img.shields.io/github/stars/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge +[stars-url]: https://github.com/OpenBB-finance/OpenBBTerminal/stargazers +[issues-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge&color=blue +[issues-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues +[bugs-open-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=yellow +[bugs-open-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aopen +[bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success +[bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed +[license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge +[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE.txt [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 [linkedin-url]: https://linkedin.com/in/DidierRLopes diff --git a/images/api_keys_part_1.png b/images/installation/api_keys_part_1.png similarity index 100% rename from images/api_keys_part_1.png rename to images/installation/api_keys_part_1.png diff --git a/images/api_keys_part_2.png b/images/installation/api_keys_part_2.png similarity index 100% rename from images/api_keys_part_2.png rename to images/installation/api_keys_part_2.png diff --git a/images/installation/macos/mac_os_installation.png b/images/installation/macos/mac_os_installation.png new file mode 100644 index 00000000000..04cfd6407fa Binary files /dev/null and b/images/installation/macos/mac_os_installation.png differ diff --git a/images/installation/macos/malicious_software_warning.png b/images/installation/macos/malicious_software_warning.png new file mode 100644 index 00000000000..9c96ccea570 Binary files /dev/null and b/images/installation/macos/malicious_software_warning.png differ diff --git a/images/installation/macos/option_one_warning_fix.png b/images/installation/macos/option_one_warning_fix.png new file mode 100644 index 00000000000..f79ece399de Binary files /dev/null and b/images/installation/macos/option_one_warning_fix.png differ diff --git a/images/installation/macos/option_two_warning_fix.png b/images/installation/macos/option_two_warning_fix.png new file mode 100644 index 00000000000..fd6f1d9dfc3 Binary files /dev/null and b/images/installation/macos/option_two_warning_fix.png differ diff --git a/images/installation/windows/run_anyway.png b/images/installation/windows/run_anyway.png new file mode 100644 index 00000000000..714ab04626c Binary files /dev/null and b/images/installation/windows/run_anyway.png differ diff --git a/images/installation/windows/run_the_terminal.png b/images/installation/windows/run_the_terminal.png new file mode 100644 index 00000000000..15e74fca43f Binary files /dev/null and b/images/installation/windows/run_the_terminal.png differ diff --git a/images/installation/windows/windows_protected_your_pc.png b/images/installation/windows/windows_protected_your_pc.png new file mode 100644 index 00000000000..fa6ac4faa54 Binary files /dev/null and b/images/installation/windows/windows_protected_your_pc.png differ diff --git a/images/GamestonkLogo.png b/images/legacy/GamestonkLogo.png similarity index 100% rename from images/GamestonkLogo.png rename to images/legacy/GamestonkLogo.png diff --git a/images/GamestonkTerminal.icns b/images/legacy/GamestonkTerminal.icns similarity index 100% rename from images/GamestonkTerminal.icns rename to images/legacy/GamestonkTerminal.icns diff --git a/images/dmg_background.png b/images/legacy/dmg_background.png similarity index 100% rename from images/dmg_background.png rename to images/legacy/dmg_background.png diff --git a/images/gst_app.ico b/images/legacy/gst_app.ico similarity index 100% rename from images/gst_app.ico rename to images/legacy/gst_app.ico diff --git a/images/gst_letters.png b/images/legacy/gst_letters.png similarity index 100% rename from images/gst_letters.png rename to images/legacy/gst_letters.png diff --git a/images/gst_logo.png b/images/legacy/gst_logo.png similarity index 100% rename from images/gst_logo.png rename to images/legacy/gst_logo.png diff --git a/images/gst_logo_green_white_background.png b/images/legacy/gst_logo_green_white_background.png similarity index 100% rename from images/gst_logo_green_white_background.png rename to images/legacy/gst_logo_green_white_background.png diff --git a/images/gst_logo_lockup_rGreen_with_letters.png b/images/legacy/gst_logo_lockup_rGreen_with_letters.png similarity index 100% rename from images/gst_logo_lockup_rGreen_with_letters.png rename to images/legacy/gst_logo_lockup_rGreen_with_letters.png diff --git a/images/gst_logo_lockup_rGreen_with_letters_only.png b/images/legacy/gst_logo_lockup_rGreen_with_letters_only.png similarity index 100% rename from images/gst_logo_lockup_rGreen_with_letters_only.png rename to images/legacy/gst_logo_lockup_rGreen_with_letters_only.png diff --git a/images/gst_logo_rGreen.png b/images/legacy/gst_logo_rGreen.png similarity index 100% rename from images/gst_logo_rGreen.png rename to images/legacy/gst_logo_rGreen.png diff --git a/images/logo.png b/images/legacy/logo.png similarity index 100% rename from images/logo.png rename to images/legacy/logo.png diff --git a/images/splashscreen.png b/images/legacy/splashscreen.png similarity index 100% rename from images/splashscreen.png rename to images/legacy/splashscreen.png diff --git a/images/openbb_gradient.png b/images/openbb_gradient.png new file mode 100644 index 00000000000..d45e0452aa5 Binary files /dev/null and b/images/openbb_gradient.png differ diff --git a/openbb_terminal/README.md b/openbb_terminal/README.md index 93ef57a103d..8a1686736e6 100644 --- a/openbb_terminal/README.md +++ b/openbb_terminal/README.md @@ -32,40 +32,40 @@ If you want to install the terminal using Python ignore the User section and jum If you are interested in running the terminal via the installer, these steps will guide you through the installation process and explain to you what each message means. -### Installing Process +### Windows -The process starts off by downloading the installer, see below the most recent release: +The process starts off by downloading the installer, see below for the most recent release: -- Windows: [LINK TO INSTALLER FILE](https://github.com/GamestonkTerminal/GamestonkTerminal/) -- macOS: [LINK TO INSTALLER FILE](https://github.com/GamestonkTerminal/GamestonkTerminal/) +- [Link to Windows installer](https://github.com/OpenBB-finance/OpenBBTerminal/releases/tag/v1.0.0) -This downloads the installer to your computer and by clicking on the created file, you are able to start -the installation process. +Then follow these steps: -**_STILL NEED TO ADD WALKTHROUGH AND IMAGES_** +| Installation instructions | Illustration | +|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------------| +|
    Double click the .exe file that got downloaded to your "Downloads" folder. You will most likely receive the error on the right stating "Windows protected your PC". This is because the installer is still in beta phase, and the team has not yet requested verification from Windows.
    |

    Windows protected your PC

    | +|
    Click on "More info" and select "Run anyway" to start the installation process. Proceed by following the steps. Do note that if you wish to install the application to 'Program Files' that you will have to run the resulting application as Administrator. |

    Run anyway

    | + |
    By clicking on the application that appeared on your Desktop, you are able to run the Terminal. The first time this takes a bit longer to load. |

    Run the terminal

    | -| Note about "Malicious Software" warning | -| :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| You will most likely see one of the following images displayed below. This is because the installer is still in beta phase, and the team has not requested verification from neither Windows nor Apple. | +### macOS -**_STILL NEED TO ADD IMAGES_** +The process starts off by downloading the installer, see below for the most recent release: -To mark the application as safe for usage, use the following steps: +- [Link to macOS installer](https://github.com/OpenBB-finance/OpenBBTerminal/releases/tag/v1.0.0) -#### On Windows +Installation instructions: -**_STILL NEED TO ADD CONTENT_** +1. Open the .dmg file that got downloaded to your "Downloads" folder. +2. Drag the folder into your "Applications" folder. This should take some time as it is extracting the +files from the .dmg file. +3. Open the folder and click on the "OpenBB Terminal" file, this should run the application. -#### On macOS +mac os installation -1. Run the file. You will most likely receive a message that macOS was not able to check whether the application - contains malicious software. The reasoning for this is described in the note above. -2. Go to macOS System Preferences > Security & Privacy > General. You should see see a message at the bottom that says - that the file "_was blocked from use because it is not from an identified developer_". -3. Click on the button "Allow anyway" -4. You should now be able to use the application. - -_WHAT ELSE?_ +| Note about "Cannot check it for malicious software" warning | Illustration | +|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------| +|
    It is possible you will see the image displayed on the right. This is because the installer is still in beta phase, and the team has not yet requested verification from Apple. Please see below how to correct for this.
    |

    software warning

    | +|
    **Option 1 (via MacOS settings):**

    1) Run the file. You will most likely receive a message that macOS was not able to check whether the application contains malicious software. The reasoning for this is described above.
    2) Go to System Preferences > Security & Privacy > General. You should see a message at the bottom that says that the file "was blocked from use because it is not from an identified developer". Click on “Allow anyway” or "Open anyway".
    3) If you receive the above message multiple times on different files, keep allowing the files via Step 2 or use Option 2.
    4) You should now be able to launch the application. |

    option 1 warning fix

    | + |
    **Option 2 (via Terminal):**

    1) Run the file. You will most likely receive a message that macOS was not able to check whether the application contains malicious software. The reasoning for this is described in the note above.
    2) Open the "Terminal" application. This can be done by using Command (⌘) + Space and typing "terminal".
    3) Within this "Terminal" application, assuming you moved the file to the Applications folder, enter the following command: `xattr -r -d com.apple.quarantine "/Applications/Gamestonk Terminal"`
    4) You should now be able to launch the application. |

    option 2 warning fix

    | ## Developer @@ -104,7 +104,7 @@ These steps are common in all operating systems (Windows with or without WSL, Ma This project supports Python 3.7, 3.8 and 3.9. Our current recommendation is to use this project with Anaconda's Python distribution - either full -[**Anaconda3 Latest**](https://repo.anaconda.com/archive/) or [**Miniconda3 Latest**](https://repo.anaconda.com/archive/). +[**Anaconda3 Latest**](https://www.anaconda.com/products/distribution) or [**Miniconda3 Latest**](https://docs.conda.io/en/latest/miniconda.html). Several features in this project utilize Machine Learning. Machine Learning Python dependencies are optional. If you decided to add Machine Learning features at a later point, you will likely have better user experience with Anaconda's Python distribution. @@ -127,13 +127,13 @@ Anaconda's Python distribution. 3. Clone the Project - - Via HTTPS: `git clone https://github.com/GamestonkTerminal/GamestonkTerminal.git` - - via SSH: `git clone git@github.com:GamestonkTerminal/GamestonkTerminal.git` + - Via HTTPS: `git clone https://github.com/OpenBB-finance/OpenBBTerminal.git` + - via SSH: `git clone git@github.com:OpenBB-finance/OpenBBTerminal.git` 4. Navigate into the project's folder ```bash - cd GamestonkTerminal/ + cd OpenBBTerminal/ ``` 5. Create Environment @@ -166,7 +166,7 @@ Anaconda's Python distribution. pip install -r requirements.txt ``` -8. You're ready to Gamestonk it! +8. You're ready to use the terminal! ```bash python terminal.py @@ -188,7 +188,7 @@ Anaconda's Python distribution. before you call `python terminal.py` again. **TROUBLESHOOT:** If you are having troubles to install, check our _newest_ -troubleshoot page. You can also reach for help on our [discord](https://discord.gg/Up2QGbMKHY). +troubleshoot page. You can also reach for help on our [discord](https://discord.gg/Up2QGbMKHY). ### Advanced User Install - Machine Learning @@ -297,7 +297,7 @@ git stash pop For API keys, create the `setenv` file if it doesn't already exist. It will automatically get created on the first launch, and won't get committed to Git because it is on the `.gitignore`. -Set the API keys [as explained here](https://github.com/GamestonkTerminal/GamestonkTerminal/blob/main/DOCKER_ADVANCED.md#environment-variables). +Set the API keys [as explained here](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/DOCKER_ADVANCED.md#environment-variables). Once you've put the API keys in that file, re-run the launch script, and it will use your API keys. There are a few things that still don't work, and you can see what works and what doesn't [here](https://github.com/CoconutMacaroon/GamestonkTerminal/blob/main/openbb_terminal_web/README.md#todo).