mirror of
https://github.com/DarkFlippers/unleashed-firmware
synced 2024-11-23 13:03:13 +00:00
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> |
||
|---|---|---|
| .. | ||
| app-scened-template | ||
| bit_lib | ||
| ble_profile | ||
| cmsis_core | ||
| cxxheaderparser@ba4222560f | ||
| datetime | ||
| digital_signal | ||
| drivers | ||
| fatfs | ||
| flipper_application | ||
| flipper_format | ||
| FreeRTOS-glue | ||
| FreeRTOS-Kernel@def7d2df2b | ||
| heatshrink@7398ccc916 | ||
| ibutton | ||
| infrared | ||
| lfrfid | ||
| libusb_stm32@6ca2857519 | ||
| littlefs@611c9b20db | ||
| mbedtls@edb8fec988 | ||
| microtar@1e921369b2 | ||
| mjs | ||
| mlib@62c8ac3e5d | ||
| music_worker | ||
| nanopb@afc499f9a4 | ||
| nfc | ||
| one_wire | ||
| pulse_reader | ||
| signal_reader | ||
| stm32wb_cmsis@d1b860584d | ||
| stm32wb_copro@d8a6f1feb0 | ||
| stm32wb_hal@cfd0dd258c | ||
| subghz | ||
| toolbox | ||
| u8g2 | ||
| update_util | ||
| appframe.scons | ||
| err.h | ||
| freertos.scons | ||
| heatshrink.scons | ||
| lfs_config.h | ||
| libusb_stm32.scons | ||
| littlefs.scons | ||
| mbedtls.scons | ||
| mbedtls_cfg.h | ||
| microtar.scons | ||
| mlib.scons | ||
| nanopb.scons | ||
| ReadMe.md | ||
| SConscript | ||
| stm32wb.scons | ||
Structure
FreeRTOS-Kernel- FreeRTOS kernel source codeFreeRTOS-glue- Extra glue to hold together FreeRTOS kernel and flipper firmwareapp-scened-template- C++ app librarybit_lib- library for working with bits/bytes directlycallback-connector- Callback connector librarycmsis_core- CMSIS Core package, contain cortex-m core headerscxxheaderparser- C++ headers parser, used by SDK bundlerdigital_signal- Digital signal library: used by NFC for software implemented protocolsdrivers- Various flipper driversfatfs- FatFS file system driverflipper_application- Flipper application library, used for FAPsflipper_format- Flipper File Format libraryheatshrink- Heatshrink compression libraryibutton- ibutton library, used by iButton applicationinfrared- Infrared library, used by Infrared applicationlfrfid- LF-RFID library, used by LF RFID applicationlibusb_stm32- LibUSB for STM32 series MCUlittlefs- LittleFS file system driver, used by internal storagembedtls- MbedTLS cryptography librarymicrotar- MicroTAR librarymlib- M-Lib C containers librarynanopb- NanoPB library, protobuf implementation for MCUnfc- NFC library, used by NFC applicationone_wire- OneWire library, used by iButton applicationprint- Tiny printf implementationdigital_signal- Digital Signal library used by NFC for software implemented protocolspulse_reader- Pulse Reader library used by NFC for software implemented protocolsstm32wb_cmsis- STM32WB series CMSIS headers, extends CMSIS Corestm32wb_copro- STM32WB Copro library: contains WPAN and radio co-processor firmwarestm32wb_hal- STM32WB HAL library, extends STM32WB CMSIS and provides HALsubghz- Subghz library, used by SubGhz applicationtoolbox- Toolbox library, contains various things that is used by Flipper firmwareu8g2- u8g2 graphics library, used by GUI subsystemupdate_util- update utilities library, used by updater