1
mirror of https://github.com/DarkFlippers/unleashed-firmware.git synced 2025-12-12 04:34:43 +04:00

docs and changelogs

This commit is contained in:
MX
2023-04-14 00:09:48 +03:00
parent c7637a0fda
commit 7922e3bb16
3 changed files with 29 additions and 21 deletions

View File

@@ -7,7 +7,6 @@
For development:
- Git
- Python3
- VSCode
## Clone the Repository
@@ -16,15 +15,24 @@ You should clone with
```shell
$ git clone --recursive https://github.com/DarkFlippers/unleashed-firmware.git
```
## VSCode integration
`fbt` includes basic development environment configuration for VS Code. Run `./fbt vscode_dist` to deploy it. That will copy the initial environment configuration to the `.vscode` folder. After that, you can use that configuration by starting VS Code and choosing the firmware root folder in the "File > Open Folder" menu.
# Build on Linux/macOS
Check out `documentation/fbt.md` for details on building and flashing firmware.
### Compile plugin and run it on connected flipper
```sh
./fbt COMPACT=1 DEBUG=0 launch_app APPSRC=applications_user/yourplugin
```
### Compile everything for development
```sh
./fbt
./fbt FIRMWARE_APP_SET=debug_pack updater_package
```
### Compile everything for release + get updater package to update from microSD card
@@ -35,7 +43,7 @@ Check out `documentation/fbt.md` for details on building and flashing firmware.
Check `dist/` for build outputs.
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
Use **`flipper-z-{target}-update-{suffix}.tgz`** to flash your device.
# Build on Windows
@@ -45,7 +53,7 @@ Check out `documentation/fbt.md` for details on building and flashing firmware.
### Compile everything for development
```sh
.\fbt.cmd
.\fbt.cmd FIRMWARE_APP_SET=debug_pack updater_package
```
### Compile everything for release + get updater package to update from microSD card
@@ -56,7 +64,7 @@ Check out `documentation/fbt.md` for details on building and flashing firmware.
Check `dist/` for build outputs.
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
Use **`flipper-z-{target}-update-{suffix}.tgz`** to flash your device.