mirror of
https://github.com/flipperdevices/flipperzero-firmware.git
synced 2025-12-12 04:41:26 +04:00
[FL-2052] New build system based on scons (#1269)
This commit is contained in:
28
ReadMe.md
28
ReadMe.md
@@ -25,6 +25,12 @@ Flipper Zero's firmware consists of two components:
|
||||
|
||||
They both must be flashed in order described.
|
||||
|
||||
## With offline update package
|
||||
|
||||
`./fbt --with-updater updater_package`
|
||||
|
||||
Copy the resulting directory to Flipper's SD card and navigate to `update.fuf` file in Archive app.
|
||||
|
||||
## With STLink
|
||||
|
||||
### Core1 Firmware
|
||||
@@ -36,17 +42,7 @@ Prerequisites:
|
||||
- [arm-gcc-none-eabi](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
|
||||
- openocd
|
||||
|
||||
One liner: `make flash`
|
||||
|
||||
### Core2 flashing procedures
|
||||
|
||||
Prerequisites:
|
||||
|
||||
- Linux / macOS
|
||||
- Terminal
|
||||
- STM32_Programmer_CLI (v2.5.0) added to $PATH
|
||||
|
||||
One liner: `make flash_radio`
|
||||
One liner: `./fbt firmware_flash`
|
||||
|
||||
## With USB DFU
|
||||
|
||||
@@ -56,7 +52,6 @@ One liner: `make flash_radio`
|
||||
- Press and hold `← Left` + `↩ Back` for reset
|
||||
- Release `↩ Back` and keep holding `← Left` until blue LED lights up
|
||||
- Release `← Left`
|
||||
<!--  -->
|
||||
|
||||
3. Run `dfu-util -D full.dfu -a 0`
|
||||
|
||||
@@ -74,7 +69,7 @@ One liner: `make flash_radio`
|
||||
## Compile everything
|
||||
|
||||
```sh
|
||||
docker-compose exec dev make
|
||||
docker-compose exec dev ./fbt
|
||||
```
|
||||
|
||||
Check `dist/` for build outputs.
|
||||
@@ -85,6 +80,8 @@ If compilation fails, make sure all submodules are all initialized. Either clone
|
||||
|
||||
# Build on Linux/macOS
|
||||
|
||||
Check out `documentation/fbt.md` for details on building and flashing firmware.
|
||||
|
||||
## macOS Prerequisites
|
||||
|
||||
Make sure you have [brew](https://brew.sh) and install all the dependencies:
|
||||
@@ -127,7 +124,7 @@ heatshrink has to be compiled [from sources](https://github.com/atomicobject/hea
|
||||
## Compile everything
|
||||
|
||||
```sh
|
||||
make
|
||||
./fbt
|
||||
```
|
||||
|
||||
Check `dist/` for build outputs.
|
||||
@@ -138,7 +135,7 @@ Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
|
||||
|
||||
Connect your device via ST-Link and run:
|
||||
```sh
|
||||
make whole
|
||||
./fbt firmware_flash
|
||||
```
|
||||
|
||||
# Links
|
||||
@@ -158,7 +155,6 @@ make whole
|
||||
- `documentation` - Documentation generation system configs and input files
|
||||
- `firmware` - Firmware source code
|
||||
- `lib` - Our and 3rd party libraries, drivers and etc...
|
||||
- `make` - Make helpers
|
||||
- `scripts` - Supplementary scripts and python libraries home
|
||||
|
||||
Also pay attention to `ReadMe.md` files inside of those directories.
|
||||
|
||||
Reference in New Issue
Block a user