From ab72f69af493165ef6ec71f8bf5fdb6a0ee2b469 Mon Sep 17 00:00:00 2001 From: Eng1n33r <10697207+xMasterX@users.noreply.github.com> Date: Wed, 20 Jul 2022 21:57:03 +0300 Subject: [PATCH] update docs --- documentation/HowToBuild.md | 32 ++++++++++++++++++++++---------- documentation/HowToInstall.md | 2 +- 2 files changed, 23 insertions(+), 11 deletions(-) diff --git a/documentation/HowToBuild.md b/documentation/HowToBuild.md index 04eccf50d..a6b5b5b4e 100644 --- a/documentation/HowToBuild.md +++ b/documentation/HowToBuild.md @@ -37,19 +37,10 @@ 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 macOS +# Build on Linux/macOS Check out `documentation/fbt.md` for details on building and flashing firmware. -## macOS Prerequisites - -Make sure you have [brew](https://brew.sh) and install all the dependencies: -```sh -brew bundle --verbose -``` - -Install Python packages required by assets build scripts: `pip3 install -r scripts/requirements.txt` - ### Compile everything for development ```sh @@ -65,3 +56,24 @@ Install Python packages required by assets build scripts: `pip3 install -r scrip 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. diff --git a/documentation/HowToInstall.md b/documentation/HowToInstall.md index 151cf6c67..90038d41f 100644 --- a/documentation/HowToInstall.md +++ b/documentation/HowToInstall.md @@ -6,7 +6,7 @@

-### **Update to the latest official firmware before proceeding** +### **If installng for first time - Update to the latest official firmware before proceeding**