Forráskód Böngészése

docs: 更新README文档以包含项目详细信息

- 添加项目用途和EPUB格式说明
- 完善项目结构和开发计划
- 保持原有开发指令不变
YourName 3 hete
szülő
commit
74305ba9e3
1 módosított fájl, 42 hozzáadás és 2 törlés
  1. 42 2
      README.md

+ 42 - 2
README.md

@@ -1,10 +1,50 @@
 # epub-build
 
-## Project setup
+## epubBuilder - EPUB电子书制作工具
+
+## 项目用途
+专门用于制作符合EPUB 3.0标准的电子书,支持:
+- 多章节内容编排
+- 元数据编辑
+- 封面图嵌入
+- 目录自动生成
+
+## EPUB格式说明
+EPUB文件本质上是包含以下结构的ZIP压缩包:
+```
+├── mimetype
+├── META-INF/container.xml
+├── OEBPS/
+│   ├── content.opf
+│   ├── toc.ncx
+│   ├── Text/
+│   │   └── chapter1.xhtml
+│   └── Images/
+│       └── cover.jpg
+```
+
+## 当前项目结构
 ```
-pnpm install
+├── public/          # 静态资源
+├── src/
+│   ├── components/  # 书签/目录组件
+│   ├── utils/       # EPUB生成核心逻辑
+│   └── views/       # 编辑器界面
 ```
 
+## 开发计划
+### 近期目标(v0.1)
+- [ ] 实现基础文本编辑器
+- [ ] 完成章节树形结构管理
+
+### 中期目标(v0.5)
+- [ ] 添加元数据编辑面板
+- [ ] 支持CSS样式注入
+
+### 长期规划(v1.0)
+- [ ] 实现EPUB校验系统
+- [ ] 开发可视化封面制作工具
+
 ### Compiles and hot-reloads for development
 ```
 pnpm run serve