mirror of
https://github.com/flipperdevices/flipperzero-firmware.git
synced 2025-12-12 04:41:26 +04:00
Drop brewfile, drop makefile, update readme and documentation (#2205)
* Drop brewfile, drop makefile, update readme * Minor grammar and consistency fixes * ReadMe: add more documentation links, cleanup layout * ReadMe: cleanup and contribution section. Roadmap: update. * Docs: Lots of minor fixes Co-authored-by: Anna Prosvetova <anna@prosvetova.me> Co-authored-by: Astra <astra@astrra.space>
This commit is contained in:
あく
187
ReadMe.md
187
ReadMe.md
@@ -1,134 +1,115 @@
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="/.github/assets/dark_theme_banner.png">
|
||||
<source media="(prefers-color-scheme: light)" srcset="/.github/assets/light_theme_banner.png">
|
||||
<img
|
||||
alt="A pixel art of a Dophin with text: Flipper Zero Official Repo"
|
||||
src="/.github/assets/light_theme_banner.png">
|
||||
</picture>
|
||||
|
||||
# Flipper Zero Firmware
|
||||
|
||||
[](http://flipperzero.one/discord)
|
||||
- [Flipper Zero Official Website](https://flipperzero.one). A simple way to explain to your friends what the Flipper Zero can do
|
||||
- [Flipper Zero Firmware Update](https://update.flipperzero.one). Improvements for your dolphin: latest firmware releases, upgrade tools for PC and Mobile devices
|
||||
- [User Documentation](https://docs.flipperzero.one). Learn more about your dolphin: specs, usage guides, and everything that you wanted to ask
|
||||
|
||||
|
||||
# Contributing
|
||||
|
||||
Welcome to [Flipper Zero](https://flipperzero.one/)'s Firmware repo!
|
||||
Our goal is to create nice and clean code with good documentation, to make it a pleasure for everyone to work with.
|
||||
Our main goal is to build a healthy, sustainable community around the Flipper and be open to any new ideas and contributions. We also have some rules and taboos here, so please read this page and our [Code Of Conduct](/CODE_OF_CONDUCT.md) carefully.
|
||||
|
||||
# Clone the Repository
|
||||
## I need help
|
||||
|
||||
The best place to search for answers is our [User Documentation](https://docs.flipperzero.one). If you can't find the answer there, you can check our [Discord Server](https://flipp.dev/discord) or our [Forum](https://forum.flipperzero.one/).
|
||||
|
||||
## I want to report an issue
|
||||
|
||||
If you've found an issue and want to report it, please check our [Issues](https://github.com/flipperdevices/flipperzero-firmware/issues) page. Make sure that the description contains information about the firmware version you're using, your platform, and the proper steps to reproduce the issue.
|
||||
|
||||
## I want to contribute code
|
||||
|
||||
Before opening a PR, please confirm that your changes must be contained in the firmware. Many ideas can easily be implemented as external applications and published in the Flipper Application Catalog (coming soon). If you are unsure, you can ask on the [Discord Server](https://flipp.dev/discord) or the [Issues](https://github.com/flipperdevices/flipperzero-firmware/issues) page, and we'll help you find the right place for your code.
|
||||
|
||||
Also, please read our [Contribution Guide](/CONTRIBUTING.md), and our [Coding Style](/CODING_STYLE.md), and ensure that your code is compatible with our project [License](/LICENSE).
|
||||
|
||||
Finally, open a [Pull Request](https://github.com/flipperdevices/flipperzero-firmware/pulls) and ensure that CI/CD statuses are all green.
|
||||
|
||||
# Development
|
||||
|
||||
The Flipper Zero Firmware is written in C, with some bits and pieces written in C++ and armv7m assembly languages. An intermediate level of C knowledge is recommended for comfortable programming. For Flipper applications, we support C, C++, and armv7m assembly languages.
|
||||
|
||||
## Requirements
|
||||
|
||||
Supported development platforms:
|
||||
|
||||
- Windows 10+ with PowerShell and Git (x86_64)
|
||||
- macOS 12+ with Command Line tools (x86_64, arm64)
|
||||
- Ubuntu 20.04+ with build-essential and Git (x86_64)
|
||||
|
||||
Supported in-circuit debuggers (optional but highly recommended):
|
||||
|
||||
- [Flipper Zero Wi-Fi Development Board](https://shop.flipperzero.one/products/wifi-devboard)
|
||||
- ST-Link
|
||||
- J-Link
|
||||
|
||||
Everything else will be taken care of by Flipper Build System.
|
||||
|
||||
## Cloning Source Code
|
||||
|
||||
Ensure that you have enough space and clone source code with Git:
|
||||
|
||||
You should clone with
|
||||
```shell
|
||||
$ git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
|
||||
git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
|
||||
```
|
||||
|
||||
# Read the Docs
|
||||
## Building
|
||||
|
||||
Check out details on [how to build firmware](documentation/fbt.md), [write applications](documentation/AppsOnSDCard.md), [un-brick your device](documentation/KeyCombo.md) and more in `documentation` folder.
|
||||
Build firmware using Flipper Build Tool:
|
||||
|
||||
# Update firmware
|
||||
|
||||
[Get Latest Firmware from Update Server](https://update.flipperzero.one/)
|
||||
|
||||
Flipper Zero's firmware consists of two components:
|
||||
|
||||
- Core2 firmware set - proprietary components by ST: FUS + radio stack. FUS is flashed at factory, and you should never update it.
|
||||
- Core1 Firmware - HAL + OS + Drivers + Applications.
|
||||
|
||||
They both must be flashed in the order described.
|
||||
|
||||
## With offline update package
|
||||
|
||||
With Flipper attached over USB:
|
||||
|
||||
`./fbt flash_usb`
|
||||
|
||||
Just building the package:
|
||||
|
||||
`./fbt updater_package`
|
||||
|
||||
To update, copy the resulting directory to Flipper's SD card and navigate to `update.fuf` file in Archive app.
|
||||
|
||||
## With STLink
|
||||
|
||||
### Core1 Firmware
|
||||
|
||||
Prerequisites:
|
||||
|
||||
- Linux / macOS
|
||||
- Terminal
|
||||
- [arm-gcc-none-eabi](https://developer.arm.com/tools-and-software/open-source-software/developer-tools/gnu-toolchain/gnu-rm/downloads)
|
||||
- openocd
|
||||
|
||||
One-liner: `./fbt firmware_flash`
|
||||
|
||||
## With USB DFU
|
||||
|
||||
1. Download latest [Firmware](https://update.flipperzero.one)
|
||||
|
||||
2. Reboot Flipper to Bootloader
|
||||
- Press and hold `← Left` + `↩ Back` for reset
|
||||
- Release `↩ Back` and keep holding `← Left` until blue LED lights up
|
||||
- Release `← Left`
|
||||
|
||||
3. Run `dfu-util -D full.dfu -a 0`
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
## Linux Prerequisites
|
||||
|
||||
The FBT tool handles everything, only `git` is required.
|
||||
|
||||
### Optional dependencies
|
||||
|
||||
- openocd (debugging/flashing over SWD)
|
||||
- heatshrink (compiling image assets)
|
||||
- clang-format (code formatting)
|
||||
- dfu-util (flashing over USB DFU)
|
||||
- protobuf (compiling proto sources)
|
||||
|
||||
For example, to install them on Debian, use:
|
||||
```sh
|
||||
apt update
|
||||
apt install openocd clang-format-13 dfu-util protobuf-compiler
|
||||
```
|
||||
|
||||
heatshrink has to be compiled [from sources](https://github.com/atomicobject/heatshrink).
|
||||
|
||||
## Compile everything
|
||||
|
||||
```sh
|
||||
```shell
|
||||
./fbt
|
||||
```
|
||||
|
||||
Check `dist/` for build outputs.
|
||||
## Flashing Firmware using an in-circuit debugger
|
||||
|
||||
Use **`flipper-z-{target}-full-{suffix}.dfu`** to flash your device.
|
||||
Connect your in-circuit debugger to the Flipper and flash firmware using Flipper Build Tool:
|
||||
|
||||
## Flash everything
|
||||
|
||||
Connect your device via ST-Link and run:
|
||||
```sh
|
||||
./fbt firmware_flash
|
||||
```shell
|
||||
./fbt flash
|
||||
```
|
||||
|
||||
## Flashing Firmware using USB
|
||||
|
||||
Ensure that your Flipper is working, connect it using a USB cable and flash firmware using Flipper Build Tool:
|
||||
|
||||
```shell
|
||||
./fbt flash_usb
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
- [Flipper Build Tool](/documentation/fbt.md) - building, flashing, and debugging Flipper software
|
||||
- [Applications](/documentation/AppsOnSDCard.md), [Application Manifest](/documentation/AppManifests.md) - developing, building, deploying, and debugging Flipper applications
|
||||
- [Hardware combos and Un-bricking](/documentation/KeyCombo.md) - recovering your Flipper from most nasty situations
|
||||
- [Flipper File Formats](/documentation/file_formats) - everything about how Flipper stores your data and how you can work with it
|
||||
- [Universal Remotes](/documentation/UniversalRemotes.md) - contributing your infrared remote to the universal remote database
|
||||
- [Firmware Roadmap](/documentation/RoadMap.md)
|
||||
- And much more in the [Documentation](/documentation) folder
|
||||
|
||||
# Links
|
||||
|
||||
* Discord: [flipp.dev/discord](https://flipp.dev/discord)
|
||||
* Website: [flipperzero.one](https://flipperzero.one)
|
||||
* Kickstarter page: [kickstarter.com](https://www.kickstarter.com/projects/flipper-devices/flipper-zero-tamagochi-for-hackers)
|
||||
* Forum: [forum.flipperzero.one](https://forum.flipperzero.one/)
|
||||
- Discord: [flipp.dev/discord](https://flipp.dev/discord)
|
||||
- Website: [flipperzero.one](https://flipperzero.one)
|
||||
- Forum: [forum.flipperzero.one](https://forum.flipperzero.one/)
|
||||
- Kickstarter: [kickstarter.com](https://www.kickstarter.com/projects/flipper-devices/flipper-zero-tamagochi-for-hackers)
|
||||
|
||||
# Project structure
|
||||
|
||||
- `applications` - Applications and services used in firmware
|
||||
- `assets` - Assets used by applications and services
|
||||
- `furi` - Furi Core: os level primitives and helpers
|
||||
- `furi` - Furi Core: OS-level primitives and helpers
|
||||
- `debug` - Debug tool: GDB-plugins, SVD-file and etc
|
||||
- `documentation` - Documentation generation system configs and input files
|
||||
- `firmware` - Firmware source code
|
||||
- `lib` - Our and 3rd party libraries, drivers, etc.
|
||||
- `scripts` - Supplementary scripts and python libraries home
|
||||
|
||||
Also pay attention to `ReadMe.md` files inside those directories.
|
||||
Also, pay attention to `ReadMe.md` files inside those directories.
|
||||
|
||||
Reference in New Issue
Block a user