Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/ClusterM/flipperzero-firmware.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorあく <alleteam@gmail.com>2021-08-08 21:03:25 +0300
committerGitHub <noreply@github.com>2021-08-08 21:03:25 +0300
commit0a97d6913c1a48156e3e2d8f339e027a003f948f (patch)
treed02cd7895df05654c4e106a28055333fd976228a /ReadMe.md
parent7907cb232bda5af7c30c79c67ab353b2cefe57c8 (diff)
Rename api-hal to furi-hal (#629)
Diffstat (limited to 'ReadMe.md')
-rw-r--r--ReadMe.md64
1 files changed, 64 insertions, 0 deletions
diff --git a/ReadMe.md b/ReadMe.md
index 5b26bd81..07e13689 100644
--- a/ReadMe.md
+++ b/ReadMe.md
@@ -66,3 +66,67 @@ One liner: `./flash_core1_main.sh`
* Project 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/)
+
+# Folders structure
+
+- applications - application and services
+ * accessor - Wiegand server
+ * archive - Archive and file manager
+ * bt - BLE service and application
+ * cli - Console service
+ * debug_tools - different tools that we use on factory and for debug
+ * dialogs - service for showing GUI dialogs
+ * dolphin - dolphin service and supplientary apps
+ * gpio-tester - GPIO control application
+ * gui - GUI service
+ * ibutton - ibutton application, onewire keys and more
+ * input - input service
+ * irda - irda application, controls your IR devices
+ * irda_monitor - irda debug tool
+ * lfrfid - LF RFID application
+ * lfrfid-debug - LF RFID debug tool
+ * loader - application loader service
+ * menu - main menu service
+ * music-player - music player app (demo)
+ * nfc - NFC application, HF rfid, EMV and etc
+ * notification - notification service
+ * power - power service
+ * power-observer - power debug tool
+ * scened-app-example - c++ application example
+ * storage - storage service, internal + sdcard
+ * storage-settings - storage settings app
+ * subghz - subghz application, 433 fobs and etc
+ * tests - unit tests and etc
+- assets - assets used by applications and services
+ * compiled - compilation results
+ * icons - source icons images
+- bootloader - bootloader for flipper
+ * src - bootloader sources
+ * targets - targets' hal and implementation
+- core - core libraries: home for furi
+- debug - debug helpers, plugins and tools
+- docker - docker image sources (used for automated firmware build)
+- firmware - firmware for flipper
+ * targets - targets' hal and implementation
+- lib - different libraries and drivers that apps and firmware uses
+ * ST25RFAL002 - ST253916 driver and NFC hal
+ * STM32CubeWB - STM32WB hal
+ * app-scened-template - scened template app library
+ * app-template - template app library
+ * callback-connector - callback connector library
+ * common-api - common api delaration library
+ * cyfral - cyfral library
+ * drivers - drivers that we wrote
+ * fatfs - external storage file system
+ * fnv1a-hash - fnv1a hash library
+ * irda - irda library
+ * littlefs - internal storage file system
+ * mlib - algorithms and containers
+ * nfc_protocols - nfc protocols library
+ * onewire - one wire library
+ * qrcode - qr code generator library
+ * subghz - subghz library
+ * toolbox - toolbox of things that we are using but don't place in core
+ * u8g2 - graphics library that we use to draw GUI
+- make - make helpers
+- scripts - supplimentary scripts