diff --git a/README.md b/README.md index 7948a42..834ca08 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,41 @@ # Инструкция по подключению релиза библиотеки `ExtendedLibs` -Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы с STM32, а также поддержку SEGGER RTT. +Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы МК, в частности STM32 и SEGGER RTT. ## Структура библиотеки +*Note: Файлы начинающиеся с `__` и которых нет в этом дереве являются **внутренними/непротестированными/недокументированными*** ``` -MyLibsGeneral -├── inc/ # Заголовочные файлы -│ ├── __mylibs_include.h # Главный include файл -│ ├── __mylibs_config.h # Конфигурация библиотек -│ ├── mylibs_defs.h # Общие определения и макросы -│ ├── bit_access.h # Битовый доступ к регистрам -│ ├── evolve_optimizer.h # Оптимизатор (генетический алгоритм) -│ ├── trackers.h # Трекеры для отладки -│ ├── trace.h # Трассировка и логирование -│ ├── general_gpio.h # Работа с GPIO -│ ├── general_spi.h # Работа с SPI -│ ├── general_tim.h # Работа с таймерами -│ └── general_uart.h # Работа с UART -└── src/ # Исходные файлы - ├── general_gpio.c # Реализация GPIO - ├── general_spi.c # Реализация SPI - ├── general_tim.c # Реализация TIM - └── general_uart.c # Реализация UART - - -RTT -├── __SEGGER_RTT_Conf.h # Конфигурационный файл RTT -├── SEGGER_RTT.c # Основной модуль RTT -├── SEGGER_RTT.h # Основной заголовок RTT -├── SEGGER_RTT_ASM_ARMv7M.S # Ассемблерная оптимизация для ARMv7M -└── SEGGER_RTT_printf.c # Реализация printf() через RTT +ProjectRoot/ +├── MyLibs/ # Общие библиотеки, независимые от платформы (или почти) +│ ├── inc/ +│ │ ├── __mylibs_include.h # Главный include файл +│ │ ├── __mylibs_config.h # Конфигурация библиотек +│ │ ├── mylibs_defs.h # Общие определения и макросы +│ │ ├── bit_access.h # Битовый доступ к регистрам +│ │ ├── evolve_optimizer.h # Оптимизатор (генетический алгоритм) +│ │ ├── trackers.h # Трекеры для отладки +│ │ └── trace.h # Трассировка и логирование +│ └── src/ +│ +├──RTT # Библиотека RTT +│ ├── __SEGGER_RTT_Conf.h # Конфигурационный файл RTT +│ ├── SEGGER_RTT.c # Основной модуль RTT +│ ├── SEGGER_RTT.h # Основной заголовок RTT +│ ├── SEGGER_RTT_ASM_ARMv7M.S # Ассемблерная оптимизация для ARMv7M +│ └── SEGGER_RTT_printf.c # Реализация printf() через RTT +│ +└── STM32_General # Работа с периферией STM32 + ├── inc/ + │ ├── general_gpio.h # Работа с GPIO + │ ├── general_spi.h # Работа с SPI + │ ├── general_tim.h # Работа с таймерами + │ └── general_uart.h # Работа с UART + └── src/ + ├── general_gpio.c # Реализация GPIO + ├── general_spi.c # Реализация SPI + ├── general_tim.c # Реализация TIM + └── general_uart.c # Реализация UART ``` ## Инструкция по подключению @@ -45,8 +50,8 @@ git submodule update --init --recursive 2. **Скопируйте файлы конфигурации и главный include** в отдельную папку в вашем проекте (вне субмодуля) и удалите `__`: ``` -project/ -├── mylibs_config/ +ProjectRoot/ +├── Configs/ │ ├── mylibs_include.h │ └── mylibs_config.h │ └── SEGGER_RTT_Conf.h @@ -74,6 +79,6 @@ git submodule update --remote ## Документация -Библиотека MyLibsGeneral документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/0.02.zip) +Библиотека `MyLibs` и `STM32_General` документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/0.02.zip) -Библиотека RTT документирована в формате [страницы википедии](https://kb.segger.com/RTT) и просто комментариями в коде. \ No newline at end of file +Библиотека `RTT` документирована в формате [страницы википедии](https://kb.segger.com/RTT) и просто комментариями в коде. \ No newline at end of file