From ab50eca0d01b49d387076fddd44bf844d319e66d Mon Sep 17 00:00:00 2001 From: Ivan Zorin Date: Sat, 1 Jul 2023 22:50:18 +0300 Subject: [PATCH] Improve section on deploy.sh usage --- Building.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/Building.md b/Building.md index 9468ac8..3341feb 100644 --- a/Building.md +++ b/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