Mirror/Momentum-Firmware
1
0
Fork 0
mirror of https://github.com/Next-Flip/Momentum-Firmware.git synced 2026-04-25 03:29:58 -07:00
Code Issues Packages Projects Releases Wiki Activity

fix: remove not printable symbols and update FAQ and BadUSB documentation links for clarity

Browse Source 
This commit improves the documentation by converting raw URLs into descriptive text links in the FAQ and BadUSB documentation. This enhances readability and navigation for users looking for specific information. Additionally, minor formatting adjustments were made for better consistency and clarity.
This commit is contained in:
DerSkythe
2024-07-24 18:39:47 +04:00
parent 72af00ecc1
commit 4ed19b518b
10 changed files with 464 additions and 434 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
documentation/HowToBuild.md
View File

@@ -1,4 +1,3 @@
# How to Build by yourself:
## Install required software
@@ -15,9 +14,10 @@ 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.
`fbt` includes basic development environment configuration for VSCode. 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 VSCode and choosing the firmware root folder in the `File > Open Folder` menu.
# Build on Linux/macOS
@@ -31,7 +31,6 @@ Check out `documentation/fbt.md` for details on building and flashing firmware.
### Compile everything for development
```sh
./fbt updater_package
```
@@ -44,8 +43,7 @@ Check out `documentation/fbt.md` for details on building and flashing firmware.
Check `dist/` for build outputs.
Use **`flipper-z-{target}-update-{suffix}.tgz`** to flash your device.
Use `flipper-z-{target}-update-{suffix}.tgz` to flash your device.
# Build on Windows
@@ -53,23 +51,20 @@ Check out `documentation/fbt.md` for details on building and flashing firmware.
### Compile everything for development
```sh
```powershell
./fbt.cmd updater_package
```
### Compile everything for release + get updater package to update from microSD card
```sh
```powershell
./fbt.cmd COMPACT=1 DEBUG=0 updater_package
```
**You may need to change** `/` **to** `\` **in front of fbt command (Only for Windows)!**
**You may need to change `/` to `\` in front of fbt command (Only for Windows)!**
Check `dist/` for build outputs.
Use **`flipper-z-{target}-update-{suffix}.tgz`** to flash your device.
Use `flipper-z-{target}-update-{suffix}.tgz` 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`.