Чет работает
This commit is contained in:
46
AllLibs/PeriphGeneral/README.md
Normal file
46
AllLibs/PeriphGeneral/README.md
Normal file
@@ -0,0 +1,46 @@
|
||||
# Инструкция по подключению релиза библиотеки `STM32_General`
|
||||
|
||||
STM32_General - это набор библиотек для удобной работы с периферией STM32.
|
||||
Данный субмодуль подключается напрямую из Git и содержит набор вспомогательных библиотек для работы МК, в частности STM32 и SEGGER RTT.
|
||||
|
||||
## Структура библиотеки
|
||||
|
||||
*Note: STM32_General требует наличия библиотеки [MyLibs](https://git.arktika.cyou/Razvalyaev/STM32_ExtendedLibs) для работы*
|
||||
```
|
||||
ProjectRoot/
|
||||
└── 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
|
||||
```
|
||||
|
||||
## Инструкция по подключению
|
||||
|
||||
1. **Склонируйте субмодуль** в ваш проект:
|
||||
|
||||
```bash
|
||||
git submodule add https://git.arktika.cyou/Razvalyaev/STM32_General path/to/STM32_General
|
||||
git submodule update --init --recursive
|
||||
```
|
||||
|
||||
2. В `mylibs_config.h` **настройте конфигурации** (@ref GENERAL_CONFIGS):
|
||||
|
||||
|
||||
|
||||
|
||||
3. **Обновление библиотеки**:
|
||||
|
||||
После обновления субмодуля из Git, исходные файлы библиотеки будут обновлены, но ваши конфиги останутся в целевой папке и не перезапишутся:
|
||||
|
||||
```bash
|
||||
git submodule update --remote
|
||||
```
|
||||
|
||||
@defgroup GENERAL_CONFIGS General Configs
|
||||
Reference in New Issue
Block a user