Skip to content

Commit e6a2e88

Browse files
committed
chore: 整理项目框架
1 parent 9cc1632 commit e6a2e88

55 files changed

Lines changed: 110 additions & 3138 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.gitmodules

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[submodule "deps/WECore"]
2+
path = deps/WECore
3+
url = https://github.com/howdy213/WECore
4+
[submodule "plugins/ExamplePlugin"]
5+
path = plugins/ExamplePlugin
6+
url = https://github.com/howdy213/ExamplePlugin

README.md

Lines changed: 36 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1+
中文 | [English](README_en.md)
12
# WidgetExplorer
23

34
## 项目介绍
45

5-
Qt插件框架
6+
WidgetExplorer 是一个基于 Qt 插件框架的桌面应用程序。
67

78
## 框架功能
89

@@ -15,25 +16,50 @@ Qt插件框架
1516

1617
1. [src](docs/src.md)
1718
主程序WidgetExplorer,解析配置文件,完成初始化
18-
2. [deps/WECore](docs/WECore.md)
19+
2. [deps/WECore](https://github.com/howdy213/WECore)
1920
生成wecore.dll,WidgetExplorer框架
2021
3. [plugins/LightWidget](docs/LightWidget.md)
21-
生成LightMain,轻量MainWidget
22-
4. [plugins/ExamplePlugin](docs/ExamplePlugin.md)
22+
生成LightMain,轻量的MainWidget
23+
4. [plugins/ExamplePlugin](https://github.com/howdy213/ExamplePlugin)
2324
生成ExamplePlugin.dll,示例插件
2425

2526
## 环境依赖
2627

27-
Qt6
28+
- Qt 6(需包含 `core``gui``widgets``qml` 模块)
29+
30+
## 快速开始
31+
32+
1. **获取源码 **
33+
34+
```bash
35+
git clone https://github.com/howdy213/WidgetExplorer.git
36+
cd WidgetExplorer
37+
```
38+
39+
2. **准备 WECore 依赖**
40+
确保 `deps/WECore` 目录下包含 WECore 源码(可通过子模块或手动下载)。
41+
42+
```bash
43+
git submodule init
44+
git submodule update
45+
```
46+
47+
3. **使用 Qt Creator 打开 `WidgetExplorer.pro`**
48+
配置构建套件(Kit),并进行编译。
49+
50+
4. **配置插件**
51+
根据需要编辑 `config/config.json` 和插件自身的配置文件(参见Release中 `plugins/` 下的示例),确保插件路径正确。
52+
53+
5. **运行**
54+
编译后运行生成的可执行文件。程序会加载所有插件,若存在多个主界面插件,则弹出选择对话框。
2855

2956
## 版本内容更新
3057

31-
###### v1.2.0
58+
###### v1.2.2
3259

33-
1. 导出类到wecore.dll中以改进二进制兼容性
34-
2. 添加一些功能
60+
1. 整理项目框架
3561

3662
## 许可证
3763

38-
本项目使用[APACHE LICENSE, VERSION 2.0](https://www.apache.org/licenses/LICENSE-2.0)许可证,详见LICENSE文件
39-
64+
WidgetExplorer 使用 Apache License 2.0 开源许可证
65+
详细信息请参阅项目根目录下的 [LICENSE](LICENSE) 文件。

README_en.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
English | [中文](README.md)
2+
3+
# WidgetExplorer
4+
5+
## Introduction
6+
7+
WidgetExplorer is a desktop application based on the Qt plugin framework.
8+
9+
## Framework Features
10+
11+
* Plugin property configuration
12+
* Switch main interface plugins
13+
* Invoke external programs as plugins
14+
* ...
15+
16+
## Project Components
17+
18+
1. [src](docs/src.md)
19+
Main program WidgetExplorer, parses configuration files and completes initialization
20+
2. [deps/WECore](https://github.com/howdy213/WECore)
21+
Generates wecore.dll, the WidgetExplorer framework
22+
3. [plugins/LightWidget](docs/LightWidget.md)
23+
Generates LightMain, a lightweight MainWidget
24+
4. [plugins/ExamplePlugin](https://github.com/howdy213/ExamplePlugin)
25+
Generates ExamplePlugin.dll, an example plugin
26+
27+
## Environment Dependencies
28+
29+
- Qt 6 (requires `core`, `gui`, `widgets`, `qml` modules)
30+
31+
## Quick Start
32+
33+
1. **Get the source code**
34+
35+
```bash
36+
git clone https://github.com/howdy213/WidgetExplorer.git
37+
cd WidgetExplorer
38+
```
39+
40+
2. **Prepare WECore dependency**
41+
Ensure the `deps/WECore` directory contains the WECore source code (can be added via submodule or manual download).
42+
43+
```bash
44+
git submodule init
45+
git submodule update
46+
```
47+
48+
3. **Open `WidgetExplorer.pro` with Qt Creator**
49+
Configure the kit and compile.
50+
51+
4. **Configure plugins**
52+
Edit `config/config.json` and the respective plugin configuration files as needed (refer to the examples in the `plugins/` directory of the release), ensuring the plugin paths are correct.
53+
54+
5. **Run**
55+
Run the generated executable after compilation. The program will load all plugins; if there are multiple main interface plugins, a selection dialog will appear.
56+
57+
## Changelog
58+
59+
###### v1.2.2
60+
61+
1. Project structure reorganization
62+
63+
## License
64+
65+
WidgetExplorer is open-sourced under the Apache License 2.0.
66+
For more details, please refer to the [LICENSE](LICENSE) file in the project root directory.

deps/WECore

Submodule WECore added at ceeb90f

deps/WECore/WConfig/wconfig.h

Lines changed: 0 additions & 120 deletions
This file was deleted.

deps/WECore/WConfig/wconfigdocument.cpp

Lines changed: 0 additions & 71 deletions
This file was deleted.

deps/WECore/WConfig/wconfigdocument.h

Lines changed: 0 additions & 48 deletions
This file was deleted.

0 commit comments

Comments
 (0)