me/IronOS
1
0
Fork 1
mirror of https://github.com/Ralim/IronOS.git synced 2025-02-26 07:53:55 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve section on deploy.sh usage

Ivan Zorin
2023-07-01 22:50:18 +03:00
parent fd00b574cf
commit ab50eca0d0
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
Building.md

@@ -14,12 +14,20 @@ To build IronOS firmware, there are quite a few different means to build this fi
## Using docker
If your machine has docker installed, you can call ```scripts/deploy.sh build``` script from the root of this repo to create a docker image, build the firmware, and output all the files in the `scripts/ci/artifacts` folder
If your machine has docker installed, you can call the script from the root of this repo:
```
$ scripts/deploy.sh build
```
This create a docker image, build the firmware, and output all the files in the `scripts/ci/artifacts` folder.
### Dev
If you just call the ```scripts/deploy.sh``` script, it will instead load you into the docker image, which is useful if you plan to run many builds to test ideas and don't want to wait for the spin up/down of the docker image.
The script can be called without any sub-commands as well:
```
scripts/deploy.sh
```
It will load you into the docker image, which is useful if you plan to run many builds to test ideas and don't want to wait for the spin up/down of the docker image.
## Using STMCubeIDE