Go to file

Aleksandr Kutuzov 491343b683 GUI: reformat sources		2020-10-16 16:36:05 +03:00
.github	Fix codestyle check pipeline (#178 )	2020-10-15 19:50:21 +03:00
applications	GUI: reformat sources	2020-10-16 16:36:05 +03:00
bootloader	Target refactoring and cube update (#161 )	2020-10-07 12:37:43 +03:00
core	Pubsub core api feature (#174 )	2020-10-15 21:23:18 +03:00
core-rs	Target refactoring and cube update (#161 )	2020-10-07 12:37:43 +03:00
docker	Fix codestyle check pipeline (#178 )	2020-10-15 19:50:21 +03:00
firmware	hotfix usb stack	2020-10-16 09:45:38 +03:00
lib	Display and UI implementation (#169 )	2020-10-14 13:21:55 +03:00
make	Display and UI implementation (#169 )	2020-10-14 13:21:55 +03:00
wiki	Core api concept (#144 )	2020-10-13 11:22:43 +03:00
wiki_static	USB, SD-card wiki updates (#172 )	2020-10-13 03:01:25 +03:00
.clang-format	always break rule (#154 )	2020-10-02 09:32:11 +03:00
.gitattributes	add wiki static as lfs files	2020-08-24 20:17:08 +03:00
.gitignore	Update .gitignore (#176 )	2020-10-14 14:11:08 +03:00
.gitmodules	Core api concept (#144 )	2020-10-13 11:22:43 +03:00
docker-compose.yml	[WIP] Add syntax check for rust and C\C++ code (#108 )	2020-09-30 02:18:30 +03:00
flipper-zero-cla.md	Update flipper-zero-cla.md	2020-08-01 19:42:32 +03:00
README.md	Broken link in Readme	2020-10-13 03:03:39 +03:00
syntax_check.sh	[WIP] Add syntax check for rust and C\C++ code (#108 )	2020-09-30 02:18:30 +03:00
wiki-deploy.sh	Implement bootloader #137 (#142 )	2020-10-01 02:05:04 +03:00

README.md

Flipper Zero Firmware community repo

Welcome to Flipper Zero's Firmware repo! Our goal is to create nice and clean code along with good documentation, to make it a pleasure for everyone to work with. This repo will become completely public closer to the device shipping date.

We are open for changes! You can suggest changes for any part of the code, wiki, guidelines, workflow, automation, etc.

If you are deary to start, please read contribution guide about creating issue, editing wiki, improving codebase and configuring environment.

Developer blog

You can read project updates in our developer blog:

Developer blog index

Firmware

Firmware page

Build and run:

You can run firmware locally (with HAL stub):

docker-compose exec dev make -C firmware TARGET=local APP_TEST=1 run for running tests
docker-compose exec dev make -C firmware TARGET=local APP_*=1 run for running examples (see applications/applications.mk for list of applications/examples)

Or you can use your dev. board:

docker-compose exec dev make -C firmware TARGET=f2 APP_*=1 flash for build and flash dev board (see applications/applications.mk for list of applications/examples)

Architecture and components

Flipper consists of the two main parts:

Core: OS, HAL, FS, bootloader, FURI
Applications: features like RFID or Tamagotchi, and also background tasks like button debouncing and backlight control.