From 684b431ea29d0e7d79e7b14e5ba0237a0d860876 Mon Sep 17 00:00:00 2001
From: sairate <sairate@sina.cn>
Date: Sun, 1 Sep 2024 15:02:20 +0800
Subject: [PATCH] Signed-off-by: sairate <sairate@sina.cn>

---
 README.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 00000000..ef970cef
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# Mkdocs 编程知识总结项目
+
+这个项目是一个基于 Mkdocs 的编程知识总结，旨在为开发者提供一个集成、易于访问的学习资源。
+
+## 安装
+
+如果你希望在本地运行项目，请按以下步骤操作：
+
+运行start.py
+
+## 使用
+
+本项目使用 Mkdocs 构建，可以通过以下命令进行配置、编译和运行：
+
+``` bash
+$ mkdocs build  # 构建静态站点
+$ mkdocs serve  # 在本地启动服务器预览
+```
+
+## 贡献
+
+我们欢迎和鼓励所有人贡献自己的知识和经验！请阅读我们的 [贡献指南](CONTRIBUTING.md) 以了解如何开始。
+