unleashed-firmware/documentation/HowToBuild.md
2022-08-23 19:32:09 +03:00

64 lines
1.3 KiB
Markdown

# How to Build by yourself:
## Install required software
- Git - [Download](https://git-scm.com/downloads) for Windows, on Linux/Mac install via package manager (`brew`, `apt`, ...)
For development:
- Git
- Python3
- VSCode
## Clone the Repository
You should clone with
```shell
$ git clone --recursive https://github.com/Eng1n33r/flipperzero-firmware.git
```
# Build on Linux/macOS
Check out `documentation/fbt.md` for details on building and flashing firmware.
### Compile everything for development
```sh
./fbt
```
### Compile everything for release + get updater package to update from microSD card
```sh
./fbt COMPACT=1 DEBUG=0 updater_package
```
Check `dist/` for build outputs.
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
# Build on Windows
Check out `documentation/fbt.md` for details on building and flashing firmware.
### Compile everything for development
```sh
.\fbt.cmd
```
### Compile everything for release + get updater package to update from microSD card
```sh
.\fbt.cmd COMPACT=1 DEBUG=0 updater_package
```
Check `dist/` for build outputs.
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
If compilation fails, make sure all submodules are all initialized. Either clone with `--recursive` or use `git submodule update --init --recursive`.