MyLibsGeneral/mainpage.h

@@ -1,6 +1,6 @@
 /*
  * Скачать HTML документацию можно здесь:
- * https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.02.zip
+ * https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.01.zip
  */
 /**
 @mainpage
@@ -9,10 +9,6 @@
 @section overview Обзор
 MyLibs - это набор библиотек для удобной работы с STM32.
 
-\htmlonly
-<a href="https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/src/branch/release">Актуальная версия</a>
-\endhtmlonly
-
 @subsection features Основные возможности
 
 @subsubsection utils_module Общие утилиты (@ref MYLIBS_DEFINES)
@@ -47,41 +43,25 @@ MyLibs - это набор библиотек для удобной работы
 @subsection structure Структура проекта
 
 @code
-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
+├── 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
 @endcode
 
-
-
-
 @subsection usage_basic Использование
 
 Инструкция по подключению:
@@ -95,4 +75,4 @@ ProjectRoot/
 
 3. Используйте нужные модули в своем коде. Примеры использования приведены в соответствующей теме
 
-*/
+ */

README.md

@@ -1,4 +1,4 @@
-# Инструкция по подключению релиза библиотеки `ExtendedLibs`
+# Инструкция по подключению релиза библиотеки `MyLibsGeneral`
 
 Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы с STM32, а также поддержку SEGGER RTT.
 
@@ -38,7 +38,7 @@ RTT
 1. **Склонируйте субмодуль** в ваш проект:
 
 ```bash
-git submodule add https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs path/to/ExtendedLibs
+git submodule add <URL_субмодуля> path/to/MyLibsGeneral
 git submodule update --init --recursive
 ```
 
@@ -74,6 +74,6 @@ git submodule update --remote
 
 ## Документация
 
-Библиотека MyLibsGeneral документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/0.02.zip)
+Библиотека MyLibsGeneral документирована в формате Doxygen. HTML документацию можно скачать [здесь](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs/archive/v0.01.zip)
 
 Библиотека RTT документирована в формате [страницы википедии](https://kb.segger.com/RTT) и просто комментариями в коде.