From 6e93af9f10b61f793ec4184c2c5adb7918532584 Mon Sep 17 00:00:00 2001
From: Wuqiyang312 <wuqiyang312@163.com>
Date: Mon, 19 Aug 2024 12:13:23 +0800
Subject: [PATCH] =?UTF-8?q?docs(README):=20=E6=B7=BB=E5=8A=A0=E9=A1=B9?=
 =?UTF-8?q?=E7=9B=AE=E4=BB=8B=E7=BB=8D=E5=92=8C=E4=BD=BF=E7=94=A8=E8=AF=B4?=
 =?UTF-8?q?=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

新增README文件，介绍stm32_uc1701_u8g2项目基于STM32微控制器，结合HAL库和FreeRTOS，使用u8g2图形库驱动UC1701显示器。文档中概述了项目的特性、依赖项，并提供了快速开始指南和项目结构概述，以帮助开发者快速上手。
---
 README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 48 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ad89c31
--- /dev/null
+++ b/README.md
@@ -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          # 项目说明文件
+```
\ No newline at end of file