docs(README): 添加项目介绍和使用说明

新增README文件,介绍stm32_uc1701_u8g2项目基于STM32微控制器,结合HAL库和FreeRTOS,使用u8g2图形库驱动UC1701显示器。文档中概述了项目的特性、依赖项,并提供了快速开始指南和项目结构概述,以帮助开发者快速上手。
This commit is contained in:
Wuqiyang312 2024-08-19 12:13:23 +08:00
parent f7cdb58aae
commit 6e93af9f10
1 changed files with 48 additions and 0 deletions

48
README.md Normal file
View File

@ -0,0 +1,48 @@
# stm32_uc1701_u8g2
该项目基于STM32微控制器结合HAL库和FreeRTOS用于驱动UC1701显示器并提供友好的图形用户界面GUI支持。项目使用 [u8g2](https://git.wqyblog.cn/wuqiyang312/u8g2-copy)
作为图形库,旨在为开发者提供一个高效的显示解决方案。
## 特性
- **HAL库集成**: 项目采用STM32的HAL库确保与硬件的良好兼容性。
- **FreeRTOS支持**: 通过集成FreeRTOS实现了任务管理和调度确保系统在多任务环境中的稳定运行。
- **u8g2图形库**: u8g2库提供了丰富的图形函数使得在UC1701显示器上实现复杂的UI变得更加简单。
## 依赖
在使用该项目之前,请确保已安装以下依赖:
- STM32 HAL库
- FreeRTOS
- u8g2图形库
## 快速开始
1. **克隆仓库**
```bash
git clone https://git.wqyblog.cn/wuqiyang312/stm32_uc1701_u8g2.git
```
2. **导入项目**
使用STM32CubeMX或者其他兼容的IDE导入项目。
3. **编译并下载**
编译项目并将其下载到目标STM32微控制器上。
4. **运行项目**
项目启动后UC1701显示器将显示出通过u8g2库绘制的图形或文本。
## 项目结构
```plaintext
stm32_uc1701_u8g2/
├── Core/ # 核心代码包括主程序入口、FreeRTOS任务等
│ ├── Inc/ # 头文件目录
│ └── Src/ # 源代码目录
├── Drivers/ # HAL库驱动和其他外设驱动
├── U8g2/ # u8g2图形库
├── Middlewares/ # 中间件如FreeRTOS等
└── README.md # 项目说明文件
```