jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix typos (#5808)

Browse Source 
* fix typo

* fix typos

* fix typo

* fix typos

* fix typos

* fix typos

* fix typo

---------

Co-authored-by: Luqman <luqazino@gmail.com>
Co-authored-by: hjoaquim <h.joaquim@campus.fct.unl.pt>
This commit is contained in:
omahs
2023-11-29 13:03:33 +01:00
committed by GitHub
parent f5317126e9
commit c8bc7fe256
7 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
build/README.md vendored
View File

@@ -10,11 +10,11 @@ In this section we detail the steps necessary to construct an installer locally
### MacOS Steps
1. `brew install create-dmg`
This installs create-dmg and it’s dependencies onto your system through brew.
This installs create-dmg and its dependencies onto your system through brew.
1. `poetry install -E installer`
This install pyinstaller and it’s dependencies onto your environment.
This install pyinstaller and its dependencies onto your environment.
3. `build/pyinstaller/build4mac.sh`
@@ -27,7 +27,7 @@ In this section we detail the steps necessary to construct an installer locally
### Windows Steps
1. `poetry install -E installer`
This install pyinstaller and it’s dependencies onto your environment.
This install pyinstaller and its dependencies onto your environment.
2. `pyinstaller build/pyinstaller/terminal.spec`
@@ -49,7 +49,7 @@ In this section we detail the steps necessary to construct an installer locally
## Github
In order to utilize the automated build workflow on the OpenBBTerminal repo, the branch in which you would like to build an installer from must already be a branch on the repo. You can also utilize the automated build workflow on a PR that is from a branch on the repo. You cannot run an automated build on a forked branch or even a PR from a forked branch.
If you are using this method to create an installer, there is a limitation where only one build automation can occur at a time per workflow. For example if there is already an installer being created on the the ‘Intel MacOS Build’ workflow, any subsequent requests for building will be queued. Additionally, the ‘Windows10 Build’ workflow runs relatively slowly because of the size of the EC2 instance it is currently on. As such, if you are interested in a quick build, then I would suggest building locally. Furthermore, building an installer this way also automatically runs integration tests on the installer.
If you are using this method to create an installer, there is a limitation where only one build automation can occur at a time per workflow. For example if there is already an installer being created on the ‘Intel MacOS Build’ workflow, any subsequent requests for building will be queued. Additionally, the ‘Windows10 Build’ workflow runs relatively slowly because of the size of the EC2 instance it is currently on. As such, if you are interested in a quick build, then I would suggest building locally. Furthermore, building an installer this way also automatically runs integration tests on the installer.
If you run into a circumstance where a requested build is queued for a long period of time, this might mean that the EC2 instance is not connected to github. If something like this arises, please create an issue.