ecab4d53d2
* Add doxygen and doxygen-awesome css, cleanup docs files * Ignore more libraries and remove leftover local variables * Create an actual intro page * .md files linting * Add doxygen action * Fix Doxygen path * Fix doxyfile path * Try to upload * Change docs branch * Add submudules checkout * Disable doxygen on PR * Mention the firmware docs in the readme * More dev docs mentions in the readme * Fix runner group, add tags * Test dev in PR * Disable running on PR * Fix a typo in the doxyfile * Try upload to S3 * Fix local path * Fix S3 ACL * Add delete flag, unifying dev and tags * Update ignored directories * More ignored directories * Even more ignored directories * Fix submodule * Change S3 uploader * Change S3 uploader version * Fix aws sync flags * Fix ACL * Disable ACL * Improve ignores, add WiFi devboard docs * TEMP: generate dev docs * TEMP: generate 0.89.0 docs * Disabling PR trigger * Enable submodules and test build * Enable test build * Disable test build * Change docs directory structure * Fix accidentally committed submodule * Fix submodules * Update links to the developer documentation * Markdown linting * Update workflow, enable test build * Fix doxygen dir path * Update Doxyfile-awesome.cfg * Change paths * Fix upload docs path * Disable pull_request debug trigger * Disable tags building * Remove autolinks and namespaces * Establish basic documentation structure * Add missing changes * Improve stylesheet, move some files * Improve examples * Improve the main page * Improve application dev docs * Improve system programming docs * Improve development tools docs * Improve other docs * Improve application examples * Fix formatting * Fix PVS-studio warnings * Improve visuals * Fix doxygen syntax warnings * Fix broken links * Update doxygen action Co-authored-by: DrunkBatya <drunkbatya.js@gmail.com> Co-authored-by: あく <alleteam@gmail.com> Co-authored-by: Georgii Surkov <georgii.surkov@outlook.com> Co-authored-by: Georgii Surkov <37121527+gsurkov@users.noreply.github.com> |
||
|---|---|---|
| .github | ||
| .vscode | ||
| applications | ||
| applications_user | ||
| assets | ||
| documentation | ||
| furi | ||
| lib | ||
| scripts | ||
| site_scons | ||
| targets | ||
| .clang-format | ||
| .editorconfig | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .pvsconfig | ||
| .pvsoptions | ||
| CODE_OF_CONDUCT.md | ||
| CODING_STYLE.md | ||
| CONTRIBUTING.md | ||
| fbt | ||
| fbt.cmd | ||
| fbt_options.py | ||
| firmware.scons | ||
| LICENSE | ||
| ReadMe.md | ||
| SConstruct | ||
Flipper Zero Firmware
- Flipper Zero Official Website. A simple way to explain to your friends what Flipper Zero can do.
- Flipper Zero Firmware Update. Improvements for your dolphin: latest firmware releases, upgrade tools for PC and mobile devices.
- User Documentation. Learn more about your dolphin: specs, usage guides, and anything you want to ask.
- Developer Documentation. Dive into the Flipper Zero Firmware source code: build system, firmware structure, and more.
Contributing
Our main goal is to build a healthy and sustainable community around Flipper, so we're 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 carefully.
I need help
The best place to search for answers is our User Documentation. If you can't find the answer there, check our Discord Server or our Forum. If you want to contribute to the firmware development, or modify it for your own needs, you can also check our Developer Documentation.
I want to report an issue
If you've found an issue and want to report it, please check our Issues page. Make sure the description contains information about the firmware version you're using, your platform, and a clear explanation of the 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. If you are unsure, reach out to us on the Discord Server or the Issues page, and we'll help you find the right place for your code.
Also, please read our Contribution Guide and our Coding Style, and make sure your code is compatible with our Project License.
Finally, open a Pull Request and make sure that CI/CD statuses are all green.
Development
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. C, C++, and armv7m assembly languages are supported for Flipper applications.
Firmware RoadMap
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
- ST-Link
- J-Link
Flipper Build System will take care of all the other dependencies.
Cloning source code
Make sure you have enough space and clone the source code:
git clone --recursive https://github.com/flipperdevices/flipperzero-firmware.git
Building
Build firmware using Flipper Build Tool:
./fbt
Flashing firmware using an in-circuit debugger
Connect your in-circuit debugger to your Flipper and flash firmware using Flipper Build Tool:
./fbt flash
Flashing firmware using USB
Make sure your Flipper is on, and your firmware is functioning. Connect your Flipper with a USB cable and flash firmware using Flipper Build Tool:
./fbt flash_usb
Documentation
- Flipper Build Tool - building, flashing, and debugging Flipper software
- Applications, Application Manifest - developing, building, deploying, and debugging Flipper applications
- Hardware combos and Un-bricking - recovering your Flipper from the most nasty situations
- Flipper File Formats - everything about how Flipper stores your data and how you can work with it
- Universal Remotes - contributing your infrared remote to the universal remote database
- Firmware Roadmap
- And much more in the Developer Documentation
Project structure
applications- applications and services used in firmwareassets- assets used by applications and servicesfuri- Furi Core: OS-level primitives and helpersdocumentation- documentation generation system configs and input filesfirmware- firmware source codelib- our and 3rd party libraries, drivers, etc.scripts- supplementary scripts and python libraries home
Also, see ReadMe.md files inside those directories for further details.
Links
- Discord: flipp.dev/discord
- Website: flipperzero.one
- Forum: forum.flipperzero.one
- Kickstarter: kickstarter.com