mirrors/unleashed-firmware
1
Fork 0
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 04:34:43 +04:00
Code Issues Activity

update docs

Browse Source
This commit is contained in:
MX
2022-08-14 06:25:32 +03:00
parent a896aa4113
commit 1beb7735a2
3 changed files with 87 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
documentation/HowToBuild.md
View File

@@ -1,6 +1,15 @@
# 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
@@ -8,6 +17,47 @@ You should clone with
$ 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.
## Build with Docker
### Prerequisites
@@ -28,7 +78,7 @@ docker-compose exec dev ./fbt
### Compile everything for release + get updater package to update from microSD card
```sh
docker-compose exec dev ./fbt --with-updater COMPACT=1 DEBUG=0 updater_package
docker-compose exec dev ./fbt COMPACT=1 DEBUG=0 updater_package
```
Check `dist/` for build outputs.
@@ -36,44 +86,3 @@ 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`.
# 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 --with-updater 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 --with-updater COMPACT=1 DEBUG=0 updater_package
```
Check `dist/` for build outputs.
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.