From 68bfce852c870cd6cb029470221d16406d2f70ec Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E6=A2=A6=E5=87=8C=E6=B1=90?= <mew@meowdream.cn>
Date: Fri, 20 Dec 2024 02:09:17 +0800
Subject: [PATCH] =?UTF-8?q?=E6=9B=B4=E6=96=B0README.md=EF=BC=8C=E6=B7=BB?=
 =?UTF-8?q?=E5=8A=A0=E9=A1=B9=E7=9B=AE=E4=BB=8B=E7=BB=8D=E5=92=8C=E4=BD=BF?=
 =?UTF-8?q?=E7=94=A8=E8=AF=B4=E6=98=8E?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md | 52 +++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 4756cdd..f454655 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,51 @@
-# ceditor
\ No newline at end of file
+# ceditor
+
+ceditor 是一个基于 C++ 的简易 Windows 终端文本编辑器，它提供了一个基本的文本编辑环境，支持语法高亮、文本导航、编辑操作等功能。
+
+## 项目结构
+
+项目包含以下主要组件和目录：
+
+- `components`: 包含编辑器的主要组件，如编辑器、文本区域、光标等。
+- `data`: 包含语法高亮的规则和数据。
+- `mystl`: 包含自定义的 STL 容器实现，如向量、列表、双端队列等。
+- `utils`: 包含一些实用工具，如动作管理器、语法分析器等。
+- `main.cpp`: 编辑器的主入口文件。
+- `CMakeLists.txt` 和 `Makefile`: 用于项目的编译和构建。
+
+## 编译
+
+项目使用 CMake 和 Makefile 进行编译。在项目根目录下，你可以使用以下命令来编译项目：
+
+```bash
+mkdir build
+cmake -G "Unix Makefiles" -S . -B build
+make -C build
+```
+
+编译完成后，可执行文件将位于 `bin` 目录下。
+
+## 使用
+
+运行编辑器：
+
+```bash
+./ceditor [file]
+```
+
+其中 `[file]` 是你想要编辑的文件路径。如果不指定文件，编辑器将显示使用方法。
+
+在编辑器中，你可以使用以下键来进行基本的编辑操作：
+
+- `i`: 进入插入模式。
+- `ESC`: 退出插入模式。
+- `m`: 打开菜单（尚未实现）。
+- 方向键：在文本中导航。
+
+## 联系方式
+
+如有任何问题或建议，请通过项目的 Issue 跟踪器提交。
+
+## 许可证
+
+本项目使用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。
\ No newline at end of file