diff --git a/ReadMe.md b/ReadMe.md index 3d5be67f1..50ad9ae43 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -7,6 +7,13 @@ Welcome to [Flipper Zero](https://flipperzero.one/)'s Custom Firmware repo! Our goal is to make any features possible in this device without any stupid limitations! Please help us realize emulation for all dynamic (rolling codes) protocols and brute-force app! +# Clone the Repository + +You should clone with +```shell +$ git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git +``` + # Update firmware [Get Latest Firmware from Update Server](https://github.com/Eng1n33r/flipperzero-firmware) @@ -74,6 +81,8 @@ 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 ## macOS Prerequisites