docs: 更新README.md格式为Markdown标准
将README.md从普通文本格式转换为标准Markdown格式,包括: - 添加标题标记 - 使用表格展示团队成员信息 - 规范章节标题格式
This commit is contained in:
parent
69c3946a08
commit
4d36b7df93
25
README.md
25
README.md
@ -1,12 +1,21 @@
|
|||||||
学习笔记整理器
|
# 学习笔记整理器
|
||||||
一、 团队成员与贡献
|
|
||||||
姓名:陈宏宇 学号:2411020204 主要贡献 (具体分工):核心逻辑开发
|
## 一、团队成员与贡献
|
||||||
姓名:周好 学号:2411020221 主要贡献 (具体分工):前端界面设计
|
|
||||||
姓名:曹涵彬 学号:2411020118 主要贡献 (具体分工):文档撰写、测试,项目讲解
|
| 姓名 | 学号 | 主要贡献 (具体分工) |
|
||||||
二、项目介绍
|
|------|------|---------------------|
|
||||||
|
| 陈宏宇 | 2411020204 | 核心逻辑开发 |
|
||||||
|
| 周好 | 2411020221 | 前端界面设计 |
|
||||||
|
| 曹涵彬 | 2411020118 | 文档撰写、测试,项目讲解 |
|
||||||
|
|
||||||
|
## 二、项目介绍
|
||||||
|
|
||||||
学习笔记管理器主要是面对学生,帮助学生对学习笔记进行整理,管理和查询。学生可以在系统中上传自己的学习笔记,系统会对笔记进行分类和整理,同时学生也可以在系统中查询自己上传的笔记,方便自己复习和学习。
|
学习笔记管理器主要是面对学生,帮助学生对学习笔记进行整理,管理和查询。学生可以在系统中上传自己的学习笔记,系统会对笔记进行分类和整理,同时学生也可以在系统中查询自己上传的笔记,方便自己复习和学习。
|
||||||
三、运行指南
|
|
||||||
|
## 三、运行指南
|
||||||
|
|
||||||
1. 安装依赖:`uv sync`
|
1. 安装依赖:`uv sync`
|
||||||
2. 配置 Key:复制 `.env.example` 为 `.env` 并填入 Key
|
2. 配置 Key:复制 `.env.example` 为 `.env` 并填入 Key
|
||||||
3. 启动:`uv run streamlit run note_organizer.py`
|
3. 启动:`uv run streamlit run note_organizer.py`
|
||||||
四、开发心得
|
|
||||||
|
## 四、开发心得
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user