Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Pull Request] Feat, Chore, Struct, Docs #189

Merged
merged 6 commits into from
Dec 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion KitX File Format Helper
2 changes: 1 addition & 1 deletion KitX Rules
2 changes: 1 addition & 1 deletion KitX Test
2 changes: 1 addition & 1 deletion KitX Tools
2 changes: 1 addition & 1 deletion KitX Website
Submodule KitX Website updated 101 files
64 changes: 49 additions & 15 deletions KitX.sln
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "解决方案项", "解决
ChangeLog.md = ChangeLog.md
clear.sh = clear.sh
CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md
commit.template.txt = commit.template.txt
ErrorCodes.md = ErrorCodes.md
LICENSE = LICENSE
nuget.config = nuget.config
Expand Down Expand Up @@ -137,12 +138,18 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestPlugin.WPF.Winform", "K
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "KitX Website", "KitX Website", "{A4F56EE3-4930-481C-A91B-EAE3AAC73659}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "KitX Website", "KitX Website\KitX Website.csproj", "{B303BF2A-229C-4FB3-A5CA-282673C9FD18}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "KitX.SameTime.Start", "KitX Tools\KitX.SameTime.Start\KitX.SameTime.Start.csproj", "{C52823D3-0909-4BEA-B9A5-60033DE233CB}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "KitX.Dashboard.VisualEffectsTest", "KitX Tools\KitX.Dashboard.VisualEffectsTest\KitX.Dashboard.VisualEffectsTest.csproj", "{8BCDD8F1-9303-4A8E-BDF7-982020AF93C9}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "KitX Website", "KitX Website\KitX Website Blazor\KitX Website.csproj", "{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "KitX Website Avalonia", "KitX Website Avalonia", "{CF91BCA6-1329-41DA-8638-9449529E2803}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "KitX Website Avalonia", "KitX Website\KitX Website Avalonia\KitX Website Avalonia\KitX Website Avalonia.csproj", "{EE3E1A23-90E8-4976-B898-A610EC2E2068}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "KitX Website Avalonia.Web", "KitX Website\KitX Website Avalonia\KitX Website Avalonia.Web\KitX Website Avalonia.Web.csproj", "{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -405,18 +412,6 @@ Global
{2BF2E4C8-46A2-4F5B-AE6B-B3460BAE3A08}.Release|x64.Build.0 = Release|Any CPU
{2BF2E4C8-46A2-4F5B-AE6B-B3460BAE3A08}.Release|x86.ActiveCfg = Release|Any CPU
{2BF2E4C8-46A2-4F5B-AE6B-B3460BAE3A08}.Release|x86.Build.0 = Release|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Debug|Any CPU.Build.0 = Debug|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Debug|x64.ActiveCfg = Debug|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Debug|x64.Build.0 = Debug|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Debug|x86.ActiveCfg = Debug|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Debug|x86.Build.0 = Debug|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Release|Any CPU.ActiveCfg = Release|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Release|Any CPU.Build.0 = Release|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Release|x64.ActiveCfg = Release|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Release|x64.Build.0 = Release|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Release|x86.ActiveCfg = Release|Any CPU
{B303BF2A-229C-4FB3-A5CA-282673C9FD18}.Release|x86.Build.0 = Release|Any CPU
{C52823D3-0909-4BEA-B9A5-60033DE233CB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{C52823D3-0909-4BEA-B9A5-60033DE233CB}.Debug|Any CPU.Build.0 = Debug|Any CPU
{C52823D3-0909-4BEA-B9A5-60033DE233CB}.Debug|x64.ActiveCfg = Debug|Any CPU
Expand All @@ -441,6 +436,42 @@ Global
{8BCDD8F1-9303-4A8E-BDF7-982020AF93C9}.Release|x64.Build.0 = Release|Any CPU
{8BCDD8F1-9303-4A8E-BDF7-982020AF93C9}.Release|x86.ActiveCfg = Release|Any CPU
{8BCDD8F1-9303-4A8E-BDF7-982020AF93C9}.Release|x86.Build.0 = Release|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Debug|x64.ActiveCfg = Debug|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Debug|x64.Build.0 = Debug|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Debug|x86.ActiveCfg = Debug|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Debug|x86.Build.0 = Debug|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Release|Any CPU.Build.0 = Release|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Release|x64.ActiveCfg = Release|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Release|x64.Build.0 = Release|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Release|x86.ActiveCfg = Release|Any CPU
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B}.Release|x86.Build.0 = Release|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Debug|Any CPU.Build.0 = Debug|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Debug|x64.ActiveCfg = Debug|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Debug|x64.Build.0 = Debug|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Debug|x86.ActiveCfg = Debug|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Debug|x86.Build.0 = Debug|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Release|Any CPU.ActiveCfg = Release|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Release|Any CPU.Build.0 = Release|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Release|x64.ActiveCfg = Release|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Release|x64.Build.0 = Release|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Release|x86.ActiveCfg = Release|Any CPU
{EE3E1A23-90E8-4976-B898-A610EC2E2068}.Release|x86.Build.0 = Release|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Debug|Any CPU.Build.0 = Debug|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Debug|x64.ActiveCfg = Debug|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Debug|x64.Build.0 = Debug|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Debug|x86.ActiveCfg = Debug|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Debug|x86.Build.0 = Debug|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Release|Any CPU.ActiveCfg = Release|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Release|Any CPU.Build.0 = Release|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Release|x64.ActiveCfg = Release|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Release|x64.Build.0 = Release|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Release|x86.ActiveCfg = Release|Any CPU
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down Expand Up @@ -479,9 +510,12 @@ Global
{A5D6E178-D883-46BC-BF26-DFC61D445CC3} = {2A5D8B91-A9CA-40FF-B821-5CE45A27312E}
{AA4F23E5-BA8F-4D8A-B1FD-ACAF358E82AC} = {81AFB1A2-B2A3-4ED7-B946-935A8A105960}
{2BF2E4C8-46A2-4F5B-AE6B-B3460BAE3A08} = {81AFB1A2-B2A3-4ED7-B946-935A8A105960}
{B303BF2A-229C-4FB3-A5CA-282673C9FD18} = {A4F56EE3-4930-481C-A91B-EAE3AAC73659}
{C52823D3-0909-4BEA-B9A5-60033DE233CB} = {CF9D7D6C-CE00-4D88-AD1C-B084BB35CA99}
{8BCDD8F1-9303-4A8E-BDF7-982020AF93C9} = {CF9D7D6C-CE00-4D88-AD1C-B084BB35CA99}
{DCFD6ABA-AF04-40FB-9742-B1F52CCAD81B} = {A4F56EE3-4930-481C-A91B-EAE3AAC73659}
{CF91BCA6-1329-41DA-8638-9449529E2803} = {A4F56EE3-4930-481C-A91B-EAE3AAC73659}
{EE3E1A23-90E8-4976-B898-A610EC2E2068} = {CF91BCA6-1329-41DA-8638-9449529E2803}
{5F6A0F65-DFF5-4912-9C68-E0AFFA5BE0A3} = {CF91BCA6-1329-41DA-8638-9449529E2803}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {09BBC227-F41B-4D10-9E38-0EEE07ED17BC}
Expand Down
86 changes: 68 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,15 @@
[![Code Size](https://img.shields.io/github/languages/code-size/Crequency/KitX?style=for-the-badge)](#)
[![Commit Activity](https://img.shields.io/github/commit-activity/m/Crequency/KitX?style=for-the-badge)](https://github.com/Crequency/KitX/commits/)

##### 🗒 Status
<details>
<summary>状态 | Status</summary>

[![Build Universal](https://img.shields.io/github/workflow/status/Crequency/KitX/Build%20Universal?style=for-the-badge&label=Build%20Universal)](https://github.com/Crequency/KitX/actions/workflows/build.yml)
[![Build Loaders](https://img.shields.io/github/workflow/status/Crequency/KitX/Build%20Loaders?style=for-the-badge&label=Build%20Loaders)](https://github.com/Crequency/KitX/actions/workflows/build-loaders.yml)
[![Build Plugins](https://img.shields.io/github/workflow/status/Crequency/KitX/Build%20Plugins?style=for-the-badge&label=Build%20Plugins)](https://github.com/Crequency/KitX/actions/workflows/build-plugins.yml)

</details>

##### 📧 Social
[![Forks](https://img.shields.io/github/forks/Crequency/KitX?style=social)](https://github.com/Crequency/KitX/network/members)
[![Stars](https://img.shields.io/github/stars/Crequency/KitX?style=social)](https://github.com/Crequency/KitX/stargazers)
Expand Down Expand Up @@ -59,42 +63,56 @@

<br>

- [文档总览 | Docs Preview](#文档总览-Docs-Preview)
<details>
<summary>目录 | Toc</summary>

- [文档总览 | Docs Preview](#文档总览-docs-preview)
- [📃 中文简介](#中文简介)
- [ℹ 应用简介](#ℹ-应用简介)
- [🗃 应用架构](#应用架构)
- [🪧 运行要求](#运行要求)
- [KitX Dashboard (面向最终用户)](#KitX-Dashboard-面向最终用户)
- [KitX Dashboard (面向最终用户)](#kitx-dashboard-面向最终用户)
- [系统支持](#系统支持)
- [环境支持](#环境支持)
- [桌面端支持](#桌面端支持)
- [移动端支持](#移动端支持)
- [📃 English Introduction](#English-Introduction)
- [ℹ App Description](#ℹ-App-Description)
- [🗃 Application Architecture](#Application-Architecture)
- [🪧 Operating requirements](#Operating-requirements)
- [KitX Dashboard (For end users)](#KitX-Dashboard-For-end-users)
- [System Support](#System-Support)
- [Environmental support](#Environmental-support)
- [Desktop support](#Desktop-support)
- [Mobile support](#Mobile-support)
- [更新周期 Update Plan](#更新周期-Update-Plan)
- [贡献者 Contributors](#贡献者-Contributors)
- [📃 English Introduction](#english-introduction)
- [ℹ App Description](#ℹ-app-description)
- [🗃 Application Architecture](#application-architecture)
- [🪧 Operating requirements](#operating-requirements)
- [KitX Dashboard (For end users)](#kitx-dashboard-for-end-users)
- [System Support](#system-support)
- [Environmental support](#environmental-support)
- [Desktop support](#desktop-support)
- [Mobile support](#mobile-support)
- [更新周期 Update Plan](#更新周期-update-plan)
- [贡献者 Contributors](#贡献者-contributors)

</details>

---

# 文档总览 | Docs Preview

<details>
<summary>展开 | Expand</summary>

| Languages | Docs |
|-----------|----------------------------------------------------------------------------------|
| zh-cn | [简体中文](https://github.com/Crequency/KitX-Docs/blob/main/zh-cn/README.md) |
| zh-cnt | [繁體中文](https://github.com/Crequency/KitX-Docs/blob/main/zh-cnt/README.md) |
| en-us | [English (US)](https://github.com/Crequency/KitX-Docs/blob/main/en-us/README.md) |
| ja-jp | [日本語](https://github.com/Crequency/KitX-Docs/blob/main/ja-jp/README.md) |

</details>

---

# 📃 中文简介

<details>
<summary>中文简介</summary>

## ℹ 应用简介
KitX 是一个开放, 共享, 免费的工具平台. 允许`开发者(第三方)`以任何`受支持的语言, 框架`为这个平台增添功能.
`最终用户`可以从`市场`中自由下载免费插件或是购买付费插件来搭建符合自己`工作流`的`快捷自动化环境`.
Expand Down Expand Up @@ -127,6 +145,10 @@ KitX 是一个开放, 共享, 免费的工具平台. 允许`开发者(第三方)
</details>

## 🗃 应用架构

<details>
<summary>展开</summary>

KitX 采用了三层设计


Expand All @@ -138,26 +160,40 @@ KitX 采用了三层设计
而这三层设计中的每一层都是可以替换的, 任何一层都可以自定义或是采用第三方的解决方案.
如此一来, 局域网中的其它设备上的插件也可以连接到当前设备, 因此可以实现局域网互联.

</details>

## 🪧 运行要求

<details>
<summary>展开</summary>

### KitX Dashboard (面向最终用户)
#### 系统支持
桌面端支持: Windows (10, 11) x64 arm, Linux x64 arm, MacOS x64 arm
移动端支持: Android (7+) arm, iOS (12+) arm
移动端支持: Android (5+) arm, iOS (12+) arm

#### 环境支持
##### 桌面端支持
全平台支持 .NET AOT 编译, 进一步增强运行速度, 但是缺少测试, 稳定性没有保证
Windows: 可选 带环境 , 与 不带环境 的便携版, 以及 在线安装包 和 离线安装包.
Windows: 可选 带环境 与 不带环境 的便携版, 以及 在线安装包 和 离线安装包.
Linux: 可选 带环境 的便携版, 也可以在 snap 中在线安装, 或者使用 .deb .rpm 包进行安装.
MacOS: 可选 带环境 的便携版, 也可以在 App Store 中在线安装.

##### 移动端支持
Android: 可选 .apk 直接安装, 以及 Crequency Hub 中在线安装.
iOS: 可选 App Store 中在线安装.

</details>

</details>

---

# 📃 English Introduction

<details>
<summary>English Introduction</summary>

## ℹ App Description

KitX is an open, shared, free tool platform. Allows `developers (3rd party)` to add functionality to the platform in any `supported languages, frameworks`.
Expand Down Expand Up @@ -191,6 +227,10 @@ Also thanks to the excellent `three-layer design`, `third parties` can use their
</details>

## 🗃 Application Architecture

<details>
<summary>Expand</summary>

KitX uses a three-layer design


Expand All @@ -202,11 +242,17 @@ Each language or framework will have a corresponding Loader to achieve interoper
Each of these three-layer designs can be replaced, and any layer can be customized or a third-party solution can be used.
In this way, plug-ins on other devices in the LAN can also be connected to the current device, so LAN interconnection can be achieved.

</details>

## 🪧 Operating requirements

<details>
<summary>Expand</summary>

### KitX Dashboard (For end users)
#### System Support
Desktop support: Windows (10, 11) x64 arm, Linux x64 arm, MacOS x64 arm
Mobile support: Android (7+) arm, iOS (12+) arm
Mobile support: Android (5+) arm, iOS (12+) arm

#### Environmental support
##### Desktop support
Expand All @@ -219,6 +265,10 @@ MacOS: Optional portable version with environment, can also be installed onlin
Android: Optional .apk direct installation, and online installation in Crequency Hub.
iOS: Optional online installation from the App Store.

</details>

</details>

---

# 更新周期 Update Plan
Expand Down Expand Up @@ -261,7 +311,7 @@ iOS: Optional online installation from the App Store.
| [v3.0.6187.47831](https://github.com/Crequency/KitX/releases/tag/v3.0.6187.47831) | Preview | Fly | :white_check_mark: | 2022.04 -> 2023.04 | .Net 6 (Also Self-Contained) | Windows, Linux, MacOS, Android, iOS, Browser, Raspberry Pi |
| [v3.22.04.6230](https://github.com/Crequency/KitX/releases/tag/v3.22.04.6230) | Preview | Telegram | :white_check_mark: | 2022.04 -> 2023.04 | .Net 6 (Also Self-Contained) | Windows, Linux, MacOS, Android, iOS, Browser, Raspberry Pi |
| [v3.22.04.6235](https://github.com/Crequency/KitX/releases/tag/v3.22.04.6235) | Release | Break | :white_check_mark: | 2022.04 -> 2023.04 | .Net 6 (Also Self-Contained) | Windows, Linux, MacOS, Android, iOS, Browser, Raspberry Pi |
| [v3.22.04.6287](https://github.com/Crequency/KitX/releases/tag/v3.22.04.6287) | Preview | Evolution | :white_check_mark: | 2022.04 -> 2023.04 | .Net 6 (Also Self-Contained) | Windows, Linux, MacOS, Android, iOS, Browser, Raspberry Pi |
| [v3.22.04.6287](https://github.com/Crequency/KitX/releases/tag/v3.22.04.6287) | Release | Evolution | :white_check_mark: | 2022.04 -> 2023.04 | .Net 6 (Also Self-Contained) | Windows, Linux, MacOS, Android, iOS, Browser, Raspberry Pi |
| v3.22.10.x | Release | Hi | coding | 2022.10 -> 2023.04 | .Net 6 (Also Self-Contained) | Windows, Linux, MacOS, Android, iOS, Browser, Raspberry Pi |
| v3.23.04.x | Release | ToYou | coding | 2023.04 -> 2024.04 | .Net 6 (Also Self-Contained) | Windows, Linux, MacOS, Android, iOS, Browser, Raspberry Pi |

Expand Down
8 changes: 8 additions & 0 deletions commit.template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# 💾/🔧/📄/🎇/🧩/✅/❌/📝/📦/🐛 Feat/Fix/Docs/Style/Refactor/Test/Test/Chore/Struct/Bug(scope): issue or changelog

# <body>

# <footer> (Breaking Changes)

# Date:
# Author: