STM32_General/Doc/latex/index.tex
2025-11-07 20:43:07 +03:00

51 lines
3.8 KiB
TeX
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

\chapter{Инструкция по подключению релиза библиотеки {\ttfamily STM32\+\_\+\+General} }
\hypertarget{index}{}\label{index}\index{Инструкция по подключению релиза библиотеки $<$tt$>$STM32\_General$<$/tt$>$@{Инструкция по подключению релиза библиотеки $<$tt$>$STM32\_General$<$/tt$>$}}
\label{index_md__e_1_2_8_w_o_r_k_2_s_t_m32_2_s_t_m___libs_2_s_t_m32___general_2_r_e_a_d_m_e}%
\Hypertarget{index_md__e_1_2_8_w_o_r_k_2_s_t_m32_2_s_t_m___libs_2_s_t_m32___general_2_r_e_a_d_m_e}%
STM32\+\_\+\+General -\/ это набор библиотек для удобной работы с периферией STM32. Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы МК, в частности STM32 и SEGGER RTT.\hypertarget{index_структура-библиотеки}{}\doxysection{\texorpdfstring{Структура библиотеки}{Структура библиотеки}}\label{index_структура-библиотеки}
\texorpdfstring{$\ast$}{*}\+Note\+: STM32\+\_\+\+General требует наличия библиотеки (My\+Libs)\mbox{[}\href{https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs}{\texttt{https\+://git.\+arktika.\+cyou/\+Razvalyaev/\+STM32\+\_\+\+Extended\+Libs}}\mbox{]} для работы\texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}\texorpdfstring{$\ast$}{*}
\begin{DoxyCode}{0}
\DoxyCodeLine{ProjectRoot/}
\DoxyCodeLine{└──\ STM32\_General\ \ \ \ \ \ \ \ \ \ \ \ \ \#\ Работа\ с\ периферией\ STM32}
\DoxyCodeLine{\ \ \ \ ├──\ inc/}
\DoxyCodeLine{\ \ \ \ \ \ \ ├──\ general\_gpio.h\ \ \ \ \ \ \ \#\ Работа\ с\ GPIO}
\DoxyCodeLine{\ \ \ \ \ \ \ ├──\ general\_spi.h\ \ \ \ \ \ \ \ \#\ Работа\ с\ SPI}
\DoxyCodeLine{\ \ \ \ \ \ \ ├──\ general\_tim.h\ \ \ \ \ \ \ \ \#\ Работа\ с\ таймерами}
\DoxyCodeLine{\ \ \ \ \ \ \ └──\ general\_uart.h\ \ \ \ \ \ \ \#\ Работа\ с\ UART}
\DoxyCodeLine{\ \ \ \ └──\ src/}
\DoxyCodeLine{\ \ \ \ \ \ \ \ ├──\ general\_gpio.c\ \ \ \ \ \ \ \#\ Реализация\ GPIO}
\DoxyCodeLine{\ \ \ \ \ \ \ \ ├──\ general\_spi.c\ \ \ \ \ \ \ \ \#\ Реализация\ SPI}
\DoxyCodeLine{\ \ \ \ \ \ \ \ ├──\ general\_tim.c\ \ \ \ \ \ \ \ \#\ Реализация\ TIM}
\DoxyCodeLine{\ \ \ \ \ \ \ \ └──\ general\_uart.c\ \ \ \ \ \ \ \#\ Реализация\ UART}
\end{DoxyCode}
\hypertarget{index_инструкция-по-подключению}{}\doxysection{\texorpdfstring{Инструкция по подключению}{Инструкция по подключению}}\label{index_инструкция-по-подключению}
\begin{DoxyEnumerate}
\item {\bfseries{Склонируйте субмодуль}} в ваш проект\+:
\end{DoxyEnumerate}
\begin{DoxyCode}{0}
\DoxyCodeLine{git\ submodule\ add\ https://git.arktika.cyou/Razvalyaev/STM32\_General\ path/to/STM32\_General}
\DoxyCodeLine{git\ submodule\ update\ -\/-\/init\ -\/-\/recursive}
\end{DoxyCode}
\begin{DoxyEnumerate}
\item В {\ttfamily mylibs\+\_\+config.\+h} {\bfseries{настройте конфигурации}} (\doxylink{group___g_e_n_e_r_a_l___c_o_n_f_i_g_s}{General Configs})\+:
\item {\bfseries{Обновление библиотеки}}\+:
\end{DoxyEnumerate}
После обновления субмодуля из Git, исходные файлы библиотеки будут обновлены, но ваши конфиги останутся в целевой папке и не перезапишутся\+:
\begin{DoxyCode}{0}
\DoxyCodeLine{git\ submodule\ update\ -\/-\/remote}
\end{DoxyCode}