unleashed-firmware/documentation/HowToBuild.md


# 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/DarkFlippers/unleashed-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`.
update readme 2022-07-10 00:47:36 +00:00
			`# How to Build by yourself:`

update docs 2022-08-14 03:25:32 +00:00			`## 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`

update readme 2022-07-10 00:47:36 +00:00			`## Clone the Repository`

			`You should clone with`
			```shell
rebranding :) 2022-10-08 23:27:38 +00:00			`$ git clone --recursive https://github.com/DarkFlippers/unleashed-firmware.git`
update readme 2022-07-10 00:47:36 +00:00			```

update docs 2022-08-14 03:25:32 +00:00			`# Build on Linux/macOS`
update readme 2022-07-10 00:47:36 +00:00
update docs 2022-08-14 03:25:32 +00:00			Check out `documentation/fbt.md` for details on building and flashing firmware.
update readme 2022-07-10 00:47:36 +00:00
			`### Compile everything for development`

			```sh
update docs 2022-08-14 03:25:32 +00:00			`./fbt`
update readme 2022-07-10 00:47:36 +00:00			```

			`### Compile everything for release + get updater package to update from microSD card`

			```sh
update docs 2022-08-14 03:25:32 +00:00			`./fbt COMPACT=1 DEBUG=0 updater_package`
update readme 2022-07-10 00:47:36 +00:00			```

			Check `dist/` for build outputs.

			Use `flipper-z-{target}-full-{suffix}.dfu` to flash your device.


update docs 2022-08-14 03:25:32 +00:00			`# Build on Windows`
update readme 2022-07-10 00:47:36 +00:00
			Check out `documentation/fbt.md` for details on building and flashing firmware.

update docs 2022-07-20 18:57:03 +00:00			`### Compile everything for development`
update readme 2022-07-10 00:47:36 +00:00
			```sh
update docs 2022-08-14 03:25:32 +00:00			`.\fbt.cmd`
update readme 2022-07-10 00:47:36 +00:00			```

update docs 2022-07-20 18:57:03 +00:00			`### Compile everything for release + get updater package to update from microSD card`

			```sh
update docs 2022-08-14 03:25:32 +00:00			`.\fbt.cmd COMPACT=1 DEBUG=0 updater_package`
update docs 2022-07-20 18:57:03 +00:00			```

			Check `dist/` for build outputs.

			Use `flipper-z-{target}-full-{suffix}.dfu` to flash your device.


update docs 2022-08-14 03:25:32 +00:00
			If compilation fails, make sure all submodules are all initialized. Either clone with `--recursive` or use `git submodule update --init --recursive`.