Skip to content

Commit 30983ec

Browse files
committed
docs: add Chinese README to root, clarify docs/README.md as directory structure guide
1 parent c0b5cd7 commit 30983ec

File tree

3 files changed

+109
-84
lines changed

3 files changed

+109
-84
lines changed

README.md

Lines changed: 29 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,40 @@
11
# Modulus
2-
Modulus - Modular Application Template for Cross-Platform Tooling
3-
4-
**Modulus** 是一个现代化的跨平台插件式工具应用模板,旨在帮助开发者快速构建可扩展、可维护、支持 AI 的桌面工具类软件。
5-
6-
该模板具备模块化架构、热插拔插件、配置系统、依赖注入、本地化、多版本兼容、签名验证等关键特性,帮助你专注业务开发而非基础设施。
7-
8-
---
9-
10-
## ✨ 特性亮点
11-
12-
- 🔌 插件热更新与动态卸载(基于 AssemblyLoadContext)
13-
- ⚙️ 插件配置支持(JSON-based)
14-
- 📦 插件依赖注入(DI 容器隔离)
15-
- 🌐 多语言本地化(支持自动切换)
16-
- 🔐 插件签名验证与版本控制
17-
- 🧠 AI Agent 插件支持(可嵌入 LLM)
18-
- 🛠️ 提供插件开发 SDK 与模板工程
19-
- 🖥️ 跨平台支持:Windows / macOS(Avalonia UI)
20-
21-
---
22-
23-
## 📦 用途场景
24-
25-
- 构建桌面数据工具 / UI 自动化工具
26-
- 快速构建开发者辅助类应用(Log Viewer、Code Generator)
27-
- 面向 AI 插件开发的任务框架
28-
- 内部工具平台(多团队协作)
29-
30-
---
31-
32-
## 🚀 快速开始
332

3+
Modulus is a modern, cross-platform, plugin-based application template designed to help developers quickly build extensible, maintainable, and AI-ready desktop tools.
4+
5+
## ✨ Features
6+
- Hot-reloadable and dynamically unloadable plugins (AssemblyLoadContext)
7+
- Plugin configuration support (JSON-based)
8+
- Dependency injection for plugins (DI container isolation)
9+
- Multi-language localization (automatic switching)
10+
- Plugin signature verification and version control
11+
- AI Agent plugin support (LLM integration)
12+
- Plugin development SDK and project templates
13+
- Cross-platform: Windows / macOS (Avalonia UI)
14+
15+
## 📦 Use Cases
16+
- Desktop data tools / UI automation tools
17+
- Rapid development of developer utilities (Log Viewer, Code Generator)
18+
- Task framework for AI plugin development
19+
- Internal tool platforms (multi-team collaboration)
20+
21+
## 🚀 Getting Started
3422
```bash
3523
dotnet new --install Modulus.Templates
3624
dotnet new modulus-plugin -n MyPlugin
3725
```
3826

39-
---
40-
41-
## 📚 文档
42-
43-
完整的项目文档可以在 [docs](./docs/README.md) 目录中找到。文档包括:
44-
45-
- **用户指南**:安装说明、使用说明和故障排除
46-
- **开发者指南**:插件开发、系统架构和 API 参考
47-
- **用户故事**:产品开发路线图和功能演进
48-
49-
文档提供多种语言版本:
27+
## 📚 Documentation
5028
- [English Documentation](./docs/en-US/README.md)
51-
- [中文文档](./docs/zh-CN/README.md)
52-
53-
---
54-
55-
## 📊 项目状态
56-
57-
查看当前项目进度与状态请参阅 [README-Project-Status.md](./README-Project-Status.md)
29+
- [中文文档 Chinese Documentation](./docs/zh-CN/README.md)
5830

59-
我们使用标准化的用户故事文档,所有 Story 文件遵循以下命名规则:
60-
- 文件格式:`S-XXXX-标题.md`
61-
- 文档标题:`# S-XXXX-标题`
62-
- 必要元数据:包含优先级和状态标记
31+
## Project Status
32+
- See progress report: [docs/reports/story-progress-report.en-US.md](./docs/reports/story-progress-report.en-US.md)
6333

64-
通过运行 `.\Generate-StoryProgress.ps1` 可生成最新的项目进度报告。
34+
## Story Naming Convention
35+
- File format: `S-XXXX-Title.md`
36+
- Document title: `# S-XXXX-Title`
37+
- Required metadata: priority and status tags
6538

66-
---
39+
## Contributing
40+
Pull requests and issues are welcome!

README.zh-CN.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Modulus 项目简介
2+
3+
Modulus 是一个现代化的跨平台插件式工具应用模板,旨在帮助开发者快速构建可扩展、可维护、支持 AI 的桌面工具类软件。
4+
5+
## ✨ 特性亮点
6+
- 插件热更新与动态卸载(基于 AssemblyLoadContext)
7+
- 插件配置支持(JSON-based)
8+
- 插件依赖注入(DI 容器隔离)
9+
- 多语言本地化(支持自动切换)
10+
- 插件签名验证与版本控制
11+
- AI Agent 插件支持(可嵌入 LLM)
12+
- 提供插件开发 SDK 与模板工程
13+
- 跨平台支持:Windows / macOS(Avalonia UI)
14+
15+
## 📦 用途场景
16+
- 构建桌面数据工具 / UI 自动化工具
17+
- 快速构建开发者辅助类应用(Log Viewer、Code Generator)
18+
- 面向 AI 插件开发的任务框架
19+
- 内部工具平台(多团队协作)
20+
21+
## 🚀 快速开始
22+
```bash
23+
dotnet new --install Modulus.Templates
24+
dotnet new modulus-plugin -n MyPlugin
25+
```
26+
27+
## 📚 文档
28+
- [English Documentation](./docs/en-US/README.md)
29+
- [中文文档](./README.zh-CN.md)
30+
31+
## 项目状态
32+
- 进度报告见 [docs/reports/story-progress-report.zh-CN.md](./docs/reports/story-progress-report.zh-CN.md)
33+
34+
## Story 命名规则
35+
- 文件格式:`S-XXXX-标题.md`
36+
- 文档标题:`# S-XXXX-标题`
37+
- 必要元数据:包含优先级和状态标记
38+
39+
## 贡献
40+
欢迎提交 issue 和 PR!

docs/zh-CN/README.md

Lines changed: 40 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,40 @@
1-
# Modulus 项目文档(中文)
2-
3-
欢迎阅读 Modulus 项目的中文文档。
4-
5-
## 用户指南
6-
7-
- [入门指南](./user-guide/getting-started.md) (待添加)
8-
- [安装指南](./user-guide/installation.md) (待添加)
9-
- [使用说明](./user-guide/usage.md)
10-
11-
## 开发者指南
12-
13-
### 插件系统
14-
15-
- [插件开发指南](./developer-guide/plugin-system/plugin-development-guide.md)
16-
- [插件 API 参考](./developer-guide/plugin-system/plugin-api-reference.md) (待添加)
17-
18-
### 系统架构
19-
20-
- [系统架构](./developer-guide/architecture/system-architecture.md) (待添加)
21-
22-
## 用户故事
23-
24-
- [故事 001: 初始项目设置](./stories/story-001.md)
25-
- [故事 002: 基础 UI 框架](./stories/story-002.md)
26-
- [故事 003: 动态插件加载](./stories/story-003.md)
27-
- [故事 004: 插件契约定义](./stories/story-004.md)
28-
- [故事 005: 插件配置和本地化](./stories/story-005.md)
29-
- [故事 006: 插件管理界面](./stories/story-006.md)
1+
# Modulus 项目简介
2+
3+
Modulus 是一个现代化的跨平台插件式工具应用模板,旨在帮助开发者快速构建可扩展、可维护、支持 AI 的桌面工具类软件。
4+
5+
## ✨ 特性亮点
6+
- 插件热更新与动态卸载(基于 AssemblyLoadContext)
7+
- 插件配置支持(JSON-based)
8+
- 插件依赖注入(DI 容器隔离)
9+
- 多语言本地化(支持自动切换)
10+
- 插件签名验证与版本控制
11+
- AI Agent 插件支持(可嵌入 LLM)
12+
- 提供插件开发 SDK 与模板工程
13+
- 跨平台支持:Windows / macOS(Avalonia UI)
14+
15+
## 📦 用途场景
16+
- 构建桌面数据工具 / UI 自动化工具
17+
- 快速构建开发者辅助类应用(Log Viewer、Code Generator)
18+
- 面向 AI 插件开发的任务框架
19+
- 内部工具平台(多团队协作)
20+
21+
## 🚀 快速开始
22+
```bash
23+
dotnet new --install Modulus.Templates
24+
dotnet new modulus-plugin -n MyPlugin
25+
```
26+
27+
## 📚 文档
28+
- [English Documentation](../en-US/README.md)
29+
- [中文文档](./README.md)
30+
31+
## 项目状态
32+
- 进度报告见 [docs/reports/story-progress-report.zh-CN.md](../reports/story-progress-report.zh-CN.md)
33+
34+
## Story 命名规则
35+
- 文件格式:`S-XXXX-标题.md`
36+
- 文档标题:`# S-XXXX-标题`
37+
- 必要元数据:包含优先级和状态标记
38+
39+
## 贡献
40+
欢迎提交 issue 和 PR!

0 commit comments

Comments
 (0)