From b822dce49553ab21000de9d702afad1cdf7f7434 Mon Sep 17 00:00:00 2001 From: Ivan Zorin Date: Sat, 1 Jul 2023 22:21:10 +0300 Subject: [PATCH] Update Building.md according to refactoring of project root directory (Ralim#1725) --- Building.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/Building.md b/Building.md index addaf56..9105d64 100644 --- a/Building.md +++ b/Building.md @@ -1,22 +1,27 @@ # Building the firmware -To build this ts100 firmware, there are quite a few different means to build this firmware +To build IronOS firmware, there are quite a few different means to build this firmware + ## Using arm compilers under Linux/Mac/WSL 1. Download and install the arm compilers (currently `gcc-arm-none-eabi-9-2019-q4-major`) 2. Install the arm compilers as appropriate -3. In a terminal change to the `./workspace/TS100` folder +3. In a terminal change to the `./source` folder 4. run `./build.sh` to build all of the firmwares 5. Alternatively run `make` with arguments to pick your device / language + ## Using docker -If your machine has docker installed, you can use the `build.sh` script in the root of this repo to create a docker image, build the firmware, and output all the files in the `ci/artifacts` folder +If your machine has docker installed, you can call the `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 + ### Dev -If you use the `./start_dev.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 dont want to wait for the spin up/down of the docker image. +If you use 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. + + ## Using STMCubeIDE If you have STMCubeIDE installed on your machine, you can use it as an IDE and build environment. Note it will use its own compilers and as such will not be reproducible builds compared to the ones uses here. @@ -30,6 +35,7 @@ If you have STMCubeIDE installed on your machine, you can use it as an IDE and b 7. Only tick the `TS100` Option 8. The firmware should now be loaded and you can right click -> build on it in the left menu + ## Using Atollic If you have Atollic installed on your machine, you can use it as an IDE and build environment. Note it will use its own compilers and as such will not be reproducible builds compared to the ones uses here. @@ -41,4 +47,5 @@ If you have Atollic installed on your machine, you can use it as an IDE and buil 5. Select Import -> General -> Existing projects into workspace 6. In the top directory option, select the `./workspace` folder 7. Only tick the `TS100A` Option -8. The firmware should now be loaded and you can right click -> build on it in the left menu \ No newline at end of file +8. The firmware should now be loaded and you can right click -> build on it in the left menu +