feat: update project metadata for AtomUI 6.0 release, enhancing descriptions and package tags

This commit is contained in:
chinboy
2026-06-15 09:46:42 +08:00
parent 83e58938ce
commit aa323db9c7
6 changed files with 113 additions and 85 deletions
+42 -36
View File
@@ -2,10 +2,10 @@
<br/>
<div align="center">
[![AntDesign](https://img.shields.io/badge/AntDesign%20-5.0-1677ff?style=flat-square&logo=antdesign)](https://ant-design.antgroup.com/components/overview)
[![AntDesign](https://img.shields.io/badge/AntDesign%20-6.0-1677ff?style=flat-square&logo=antdesign)](https://ant-design.antgroup.com/components/overview)
[![][github-contributors-shield]][github-contributors-link]
[![][github-stars-shield]][github-stars-link]
[![Nuget Download](https://img.shields.io/nuget/dt/AtomUI.Desktop.Controls?style=flat-square&logo=nuget&label=downloads)](https://www.nuget.org/packages/AtomUI.Desktop.Controls)
[![NuGet Download](https://img.shields.io/nuget/dt/AtomUI.Desktop.Controls?style=flat-square&logo=nuget&label=downloads)](https://www.nuget.org/packages/AtomUI.Desktop.Controls)
[![][github-license-shield]][github-license-link]
[Changelog](./CHANGELOG.md) · [Report Bug][github-issues-link] · [Request Feature][github-issues-link]
@@ -44,22 +44,27 @@
Documentation Language: [English](README.md) | [简体中文](README.zh-CN.md)
#### Introduce
#### Overview
AtomUI is an implementation of Ant Design based on .NET technology, dedicated to bringing the excellent and efficient
design language and experience of Ant Design to the Avalonia/.NET cross-platform desktop software development field.
AtomUI is an Ant Design 6 component system for Avalonia/.NET desktop applications. It brings Ant Design's enterprise
interaction patterns, visual language, design tokens and theme customization model to native cross-platform apps on
Windows, macOS and Linux.
Welcome to communicate and give suggestions to AtomUI, thank you for giving the project a Star.
The project includes production-oriented desktop controls, icon packages, font packages, native window integration,
DataGrid, ColorPicker and source generators for custom controls, tokens and localization. Feedback, issues and pull
requests are welcome.
<img src="./resources/images/readme/Gallery.png"/>
#### Features
- Enterprise-class UI designed from Ant Design system for cross platform desktop applications.
- A set of high-quality Avalonia Controls out of the box.
- Use .NET development to achieve one-stop writing, seamless compilation on mainstream operating system platforms and
render a consistent UI experience.
- Based on Avalonia's powerful style system, Ant Design's theme customization capabilities are fully implemented.
- Ant Design 6 experience adapted for native Avalonia desktop applications.
- A broad set of ready-to-use controls for enterprise software, including layout, navigation, data entry, feedback,
data display and optional advanced packages.
- Token-driven theming built on Avalonia's style and resource system, with support for consistent customization across
controls.
- Cross-platform desktop support for Windows, macOS and Linux with a shared .NET/XAML development model.
- Source generators for custom controls, theme tokens and localization to reduce repetitive infrastructure code.
#### Requirements
@@ -82,7 +87,7 @@ Thanks to Tongming Lake Center for their incubation support of AtomUI OSS
<tr>
<th>Telegram</th>
<th>WhatsApp</th>
<th>Wechat Group</th>
<th>WeChat Group</th>
<th>QQ Group</th>
</tr>
<tr>
@@ -96,11 +101,10 @@ Thanks to Tongming Lake Center for their incubation support of AtomUI OSS
#### Get Started
##### Add nuget package:
##### Add NuGet packages
AtomUI is recommended to be installed as a nuget package. We have uploaded AtomUI OSS-related packages to nuget.org.
Currently, AtomUI
has not released a long-term support version, so it is recommended to install the latest version we have released
AtomUI is distributed through NuGet. Install the main desktop controls package first, then add optional packages such as
DataGrid and ColorPicker only when your application needs them. The examples below use the latest project version.
The packages we have released are as follows:
@@ -109,6 +113,7 @@ The packages we have released are as follows:
| AtomUI.Native | Native platform infrastructure |
| AtomUI.Core | Core infrastructure — theme system, token system and animations |
| AtomUI.Fonts.AlibabaSans | Alibaba Sans font package |
| AtomUI.Fonts.AlibabaPuHuiTi | Alibaba PuHuiTi font package |
| AtomUI.Icons.Shared | Icon infrastructure |
| AtomUI.Icons.AntDesign | Ant Design icon package |
| AtomUI.Controls.Shared | Shared interfaces and enums for control development |
@@ -119,18 +124,19 @@ The packages we have released are as follows:
| AtomUI.Generator | Source generators for custom controls, tokens and localization |
```bash
dotnet add package AtomUI.Desktop.Controls --version 6.0.0-build.1
dotnet add package AtomUI.Desktop.Controls.DataGrid --version 6.0.0-build.1
dotnet add package AtomUI.Desktop.Controls.ColorPicker --version 6.0.0-build.1
dotnet add package AtomUI.Desktop.Controls --version 6.0.4
dotnet add package AtomUI.Desktop.Controls.DataGrid --version 6.0.4
dotnet add package AtomUI.Desktop.Controls.ColorPicker --version 6.0.4
```
You can install nuget packages one by one directly. If the above command line fails to complete the installation, please go to the NuGet package manager. In Rider, you can click on the following steps:
You can also install the packages from your IDE's NuGet package manager. In Rider, open:
nuget -> packages
NuGet -> Packages
Searching for "AtomUI" will find available AtomUI packages. Then, install them one by one.
Search for "AtomUI" and install the packages your project needs.
> Before installation, please click on "Framework and Dependencies" on the right to ensure that the corresponding dependency packages are compatible.
> Before installation, check "Frameworks" and "Dependencies" in the package details to confirm compatibility with your
> target framework and Avalonia version.
##### Enable AtomUI library
@@ -148,9 +154,9 @@ Searching for "AtomUI" will find available AtomUI packages. Then, install them o
</PropertyGroup>
<ItemGroup>
<PackageReference Include="AtomUI.Desktop.Controls" Version="6.0.0-build.1"/>
<PackageReference Include="AtomUI.Desktop.Controls.DataGrid" Version="6.0.0-build.1"/>
<PackageReference Include="AtomUI.Desktop.Controls.ColorPicker" Version="6.0.0-build.1"/>
<PackageReference Include="AtomUI.Desktop.Controls" Version="6.0.4"/>
<PackageReference Include="AtomUI.Desktop.Controls.DataGrid" Version="6.0.4"/>
<PackageReference Include="AtomUI.Desktop.Controls.ColorPicker" Version="6.0.4"/>
<PackageReference Include="AvaloniaUI.DiagnosticsSupport" Version="2.2.1"/>
</ItemGroup>
</Project>
@@ -213,9 +219,9 @@ public partial class App : Application
}
```
###### Enjoy using AtomUI to create unlimited possibilities
###### Start building with AtomUI
You can start using it in your own projects
After AtomUI is registered, you can use AtomUI controls and Ant Design icons directly in XAML.
```xml
<atom:Window xmlns="https://github.com/avaloniaui"
@@ -232,7 +238,8 @@ You can start using it in your own projects
#### All Control Gallery
You can launch the `./controlgallery/AtomUIGallery.Desktop/AtomUIGallery.Desktop.csproj` project in your local development environment to experience all AtomUI controls.
You can launch the gallery project locally to browse the available controls, usage patterns, design tokens and API
tables.
```bash
git clone https://github.com/AtomUI/AtomUI.git
@@ -244,11 +251,11 @@ dotnet run --project controlgallery/AtomUIGallery.Desktop/AtomUIGallery.Desktop.
#### Simple Examples
AtomUI's gallery project can be quite large and complex, and if you're new to AtomUI, you might feel overwhelmed. You can visit
The gallery is intentionally comprehensive. If you prefer compact starter projects, visit:
[AtomUI/AtomUI.Examples](https://github.com/AtomUI/AtomUI.Samples)
to check out our simple and compact sample projects to help you get started with AtomUI.
These samples show smaller application setups that are easier to copy into a new project.
#### Acknowledgements
@@ -271,11 +278,10 @@ Avalonia is a cross-platform .NET UI framework that uses XAML language for inter
#### License Description
Projects using AtomUI OSS need to comply with the LGPL v3 agreement. <strong>Commercial applications (including but not
limited to internal company projects, commercial projects developed by individuals using AtomUI OSS, and outsourced
projects) are free when using binary links</strong>. If you want to customize AtomUI based on source code, you need to
modify the open source code or purchase a commercial license. If you need a commercial license, please contact: Beijing
Qinware Technology Co., Ltd.
Projects using AtomUI OSS must comply with LGPL v3. <strong>Commercial applications, including internal company
software, personal commercial products and outsourced projects, may use AtomUI for free when linking to the published
binaries</strong>. If you customize AtomUI from source code, you must either open source the modified code under the
license terms or purchase a commercial license. For commercial licensing, contact Beijing Qinware Technology Co., Ltd.
#### Special thanks
+31 -14
View File
@@ -1,25 +1,42 @@
## AtomUI
#### Introduce
AtomUI is an Ant Design 6 component system for Avalonia/.NET desktop applications. It brings Ant Design's enterprise
interaction patterns, visual language, design tokens and theme customization model to native cross-platform apps on
Windows, macOS and Linux.
AtomUI is an implementation of Ant Design based on .NET technology, dedicated to bringing the excellent and efficient design language and experience of Ant Design to the Avalonia/.NET cross-platform desktop software development field.
### What It Includes
Welcome to communicate and give suggestions to AtomUI, thank you for giving the project a Star.
- Production-oriented Avalonia desktop controls for layout, navigation, data entry, feedback and data display.
- Token-driven theming built on Avalonia's style and resource system.
- Ant Design icon packages, font packages and native desktop integration.
- Optional advanced packages such as `AtomUI.Desktop.Controls.DataGrid` and `AtomUI.Desktop.Controls.ColorPicker`.
- Source generators for custom controls, theme tokens and localization infrastructure.
#### Features
### Install
- Enterprise-class UI designed from Ant Design system for cross platform desktop applications.
- A set of high-quality Avalonia Controls out of the box.
- Use .NET development to achieve one-stop writing, seamless compilation on mainstream operating system platforms and render a consistent UI experience.
- Based on Avalonia's powerful style system, Ant Design's theme customization capabilities are fully implemented.
Install the main desktop controls package first, then add optional packages only when your application needs them.
#### License Description
Projects using AtomUI need to comply with the LGPL v3 agreement. <strong>Commercial applications (including but not limited to internal company projects, commercial projects developed by individuals using AtomUI, and outsourced projects) are free when using binary links</strong>. If you want to customize AtomUI based on source code, you need to modify the open source code or purchase a commercial license. If you need a commercial license, please contact: Beijing Qinware Software Technology Co., Ltd.
```bash
dotnet add package AtomUI.Desktop.Controls --version 6.0.4
dotnet add package AtomUI.Desktop.Controls.DataGrid --version 6.0.4
dotnet add package AtomUI.Desktop.Controls.ColorPicker --version 6.0.4
```
### 🤝 Contributing
### Requirements
Contributions of all types are more than welcome, if you are interested in contributing code, feel free to check out our GitHub [Issues][github-issues-link] to get stuck in to show us what you’re made of.
- .NET 8 or later
- Avalonia 12.0.x
- Windows, macOS or Linux
#### About Qinware
### Links
Qinware Technology Co., Ltd. is a technology company dedicated to the development of productivity tool software. Since its inception, it has been determined to deepen its roots in the field of tool software, practice the spirit of continuous improvement in research and development, and strive to launch high-quality productivity tool software to serve developers at home and abroad, improve developers' work efficiency, and create commercial value and social value.
- Repository: https://github.com/AtomUI/AtomUI
- Issues: https://github.com/AtomUI/AtomUI/issues
- Samples: https://github.com/AtomUI/AtomUI.Samples
### License
Projects using AtomUI OSS must comply with LGPL v3. Commercial applications, including internal company software,
personal commercial products and outsourced projects, may use AtomUI for free when linking to the published binaries.
If you customize AtomUI from source code, you must either open source the modified code under the license terms or
purchase a commercial license.
+37 -32
View File
@@ -2,8 +2,8 @@
<br/>
<div align="center">
[![AntDesign](https://img.shields.io/badge/AntDesign%20-5.0-1677ff?style=flat-square&logo=antdesign)](https://ant-design.antgroup.com/components/overview-cn)
[![Nuget Download](https://img.shields.io/nuget/dt/AtomUI.Desktop.Controls?style=flat-square&logo=nuget&label=downloads)](https://www.nuget.org/packages/AtomUI.Desktop.Controls)
[![AntDesign](https://img.shields.io/badge/AntDesign%20-6.0-1677ff?style=flat-square&logo=antdesign)](https://ant-design.antgroup.com/components/overview-cn)
[![NuGet Download](https://img.shields.io/nuget/dt/AtomUI.Desktop.Controls?style=flat-square&logo=nuget&label=downloads)](https://www.nuget.org/packages/AtomUI.Desktop.Controls)
[![][github-license-shield]][github-license-link]
[更新日志](./CHANGELOG.md) · [提交Bug][github-issues-link] · [提交需求][github-issues-link]
@@ -44,17 +44,21 @@
#### 介绍
AtomUI 是基于 .NET 技术的 Ant Design 实现,致力于将 Ant Design 优秀而高效的设计语言和体验带入 Avalonia/.NET 跨平台桌面软件开发领域。
欢迎与 AtomUI 进行交流并提出建议,感谢您为该项目点赞。
AtomUI 是面向 Avalonia/.NET 桌面应用的 Ant Design 6 组件体系,目标是把 Ant Design 的企业级交互模式、
视觉语言、设计 Token 和主题定制能力带到 Windows、macOS、Linux 原生跨平台应用中。
项目提供面向生产场景的桌面控件、图标包、字体包、原生窗口集成、DataGrid、ColorPicker,以及用于自定义控件、
Token 和本地化开发的源代码生成器。欢迎提交 Issue、PR 和改进建议。
<img src="./resources/images/readme/Gallery.png"/>
#### 特性
- 实现 Ant Design 提炼自企业级中后台产品的交互语言和视觉风格。
- 开箱即用的高质量 Avalonia 组件。
- 使用 .NET 开发,实现一处编写,无缝在主流操作系统平台编译并且渲染出一致的 UI 体验。
- 基于 Avalonia 强大的风格系统,完整实现了 Ant Design 的主题定制能力。
- 将 Ant Design 6 的交互体验和视觉体系适配到原生 Avalonia 桌面应用。
- 提供覆盖布局、导航、数据录入、反馈、数据展示等场景的开箱即用控件,并按需提供 DataGrid、ColorPicker 等高级包。
- 基于 Avalonia 样式与资源系统实现 Token 驱动的主题能力,便于在应用级统一定制视觉风格。
- 使用统一的 .NET/XAML 开发模型支持 Windows、macOS、Linux 跨平台桌面应用。
- 提供自定义控件、主题 Token、本地化相关的源代码生成能力,减少重复基础设施代码。
#### 运行环境
@@ -76,13 +80,13 @@ Avalonia 12.0.x<br>
#### 中文社区
目前我们暂时只创建 QQ 和微信开发者群的交流方式,下面是二维码,有兴趣的同学可以扫码加入:
目前我们提供 QQ 和微信开发者交流群,欢迎对 AtomUI 或 Avalonia 感兴趣的开发者扫码加入:
<table border="0">
<tbody>
<tr>
<td align="center" valign="middle">
<img src="./resources/images/readme/wechat.jpg" width="200" height="200"/>
<img src="./resources/images/readme/wechat.jpg" width="200"/>
</td>
<td align="center" valign="middle">
<img src="./resources/images/readme/QQ.png" width="200" height="200"/>
@@ -91,12 +95,12 @@ Avalonia 12.0.x<br>
</tbody>
</table>
> PS:扫码请注明来意,比如:学习`AtomUI`或者`Avalonia`爱好者
> PS:扫码请注明来意,比如:学习 `AtomUI` 或 `Avalonia` 爱好者。
#### 开始使用
AtomUI 推荐的以 nuget 包的方式进行安装,我们已经将 AtomUI OSS 相关的包上传到 nuget.org,目前 AtomUI
没有发布长期支持版,所以推荐安装我们发布的最新版本
AtomUI 推荐通过 NuGet 安装。先安装主桌面控件包,再根据应用需要按需添加 DataGrid、ColorPicker 等可选包。
下面示例使用当前项目最新版本。
目前我们已经发布的包如下:
@@ -104,7 +108,8 @@ AtomUI 推荐的以 nuget 包的方式进行安装,我们已经将 AtomUI OSS
|-------------------------------------|---------------------------------|
| AtomUI.Native | 原生平台适配基础设施 |
| AtomUI.Core | 核心基础设施 — 主题系统、Token 系统、动画 |
| AtomUI.Fonts.AlibabaSans | 阿里巴巴普惠体字体包 |
| AtomUI.Fonts.AlibabaSans | Alibaba Sans 字体包 |
| AtomUI.Fonts.AlibabaPuHuiTi | 阿里巴巴普惠体字体包 |
| AtomUI.Icons.Shared | 图标基础设施 |
| AtomUI.Icons.AntDesign | Ant Design 图标包 |
| AtomUI.Controls.Shared | 面向控件开发的共享接口与枚举 |
@@ -115,18 +120,18 @@ AtomUI 推荐的以 nuget 包的方式进行安装,我们已经将 AtomUI OSS
| AtomUI.Generator | 面向自定义控件、Token 与本地化开发的源代码生成器 |
```bash
dotnet add package AtomUI.Desktop.Controls --version 6.0.0-build.1
dotnet add package AtomUI.Desktop.Controls.DataGrid --version 6.0.0-build.1
dotnet add package AtomUI.Desktop.Controls.ColorPicker --version 6.0.0-build.1
dotnet add package AtomUI.Desktop.Controls --version 6.0.4
dotnet add package AtomUI.Desktop.Controls.DataGrid --version 6.0.4
dotnet add package AtomUI.Desktop.Controls.ColorPicker --version 6.0.4
```
您也可以直接依次安装各个nuget包。如果上述命令行无法完成正常安装,请移步nuget包管理器,在rider中,您可以依次点击
您也可以在 IDE 的 NuGet 包管理器中安装。以 Rider 为例,可以依次点击:
nuget -> 软件包
NuGet -> 软件包
搜索AtomUI,即可搜索到可用的AtomUI包。然后依次安装即可。
搜索 `AtomUI`,即可找到可用包,并按项目需要安装。
> 安装前请点击右侧 框架 和 依赖,确保满足相应的依赖包版本
> 安装前请查看包详情中的“框架”和“依赖”,确认目标框架与 Avalonia 版本兼容。
##### 启用 AtomUI 库
@@ -144,9 +149,9 @@ nuget -> 软件包
</PropertyGroup>
<ItemGroup>
<PackageReference Include="AtomUI.Desktop.Controls" Version="6.0.0-build.1"/>
<PackageReference Include="AtomUI.Desktop.Controls.DataGrid" Version="6.0.0-build.1"/>
<PackageReference Include="AtomUI.Desktop.Controls.ColorPicker" Version="6.0.0-build.1"/>
<PackageReference Include="AtomUI.Desktop.Controls" Version="6.0.4"/>
<PackageReference Include="AtomUI.Desktop.Controls.DataGrid" Version="6.0.4"/>
<PackageReference Include="AtomUI.Desktop.Controls.ColorPicker" Version="6.0.4"/>
<PackageReference Include="AvaloniaUI.DiagnosticsSupport" Version="2.2.1"/>
</ItemGroup>
</Project>
@@ -209,9 +214,9 @@ public partial class App : Application
}
```
###### 开始用 `AtomUI` 创造无限可能
###### 开始使用 AtomUI
您可以开始在自己的项目中开始使用 `AtomUI`
注册 AtomUI 后,可以直接在 XAML 中使用 AtomUI 控件和 Ant Design 图标。
```xml
<atom:Window xmlns="https://github.com/avaloniaui"
@@ -228,7 +233,7 @@ public partial class App : Application
#### 体验所有控件
您可以启动 `./controlgallery/AtomUIGallery.Desktop/AtomUIGallery.Desktop.csproj` 项目在本机开发环境来体验所有的 AtomUI 控件
您可以在本机启动 Gallery 项目,浏览 AtomUI 控件、典型用法、设计 Token 和 API 表格。
```bash
git clone https://github.com/AtomUI/AtomUI.git
@@ -240,11 +245,11 @@ dotnet run --project controlgallery/AtomUIGallery.Desktop/AtomUIGallery.Desktop.
#### 小的示例项目
AtomUI 的 gallery 项目可能过于庞大繁杂,如果您刚开始接触 AtomUI,可能会感到无从下手,您可以前往
Gallery 项目覆盖面较完整。如果您希望先看更小的入门项目,可以前往:
[AtomUI/AtomUI.Examples](https://github.com/AtomUI/AtomUI.Samples)
查看简单且小巧的示例项目。帮助您更好的上手 AtomUI。
这些示例展示了更紧凑的应用搭建方式,更适合作为新项目起点。
#### 致谢
@@ -266,9 +271,9 @@ Avalonia 是一个跨平台的 .NET UI 框架,使用 XAML 语言设计界面
#### 许可证说明
使用 AtomUI 的项目需要遵循 LGPL v3 协议,<strong>商业应用(包括且不限于公司内部项目、个人使用 AtomUI OSS
开发的商业项目和承接的外包项目)在使用二进制连接的情况下免费</strong>,如果基于源码定制 AtomUI
需要修改的代码开源或者购买商业授权,需要商业授权,欢迎联系:北京秦派软件科技有限公司。
使用 AtomUI OSS 的项目需要遵循 LGPL v3 协议。<strong>商业应用,包括公司内部项目、个人商业项目和外包项目,
在使用已发布二进制包链接的情况下可以免费使用</strong>。如果基于源码定制 AtomUI,则需要按协议开放修改代码,
或购买商业授权。商业授权请联系:北京秦派软件科技有限公司。
#### 特别感谢
+3 -3
View File
@@ -4,8 +4,8 @@
<Title>AtomUI</Title>
<Author>Qinware Technologies Ltd.</Author>
<Authors>$(Author)</Authors>
<Description>AtomUI is an implementation of AntDesigin based on .NET technology, and is committed to bringing AntDesign's excellent and efficient design language and experience to the Avalonia/.NET cross-platform desktop software development field.</Description>
<PackageTags>avalonia;AntDesigin;UI;Control Library</PackageTags>
<Description>AtomUI is an Ant Design 6 component system for Avalonia/.NET desktop applications, including themed controls, design tokens, icons, native window integration and optional DataGrid and ColorPicker packages.</Description>
<PackageTags>avalonia;AntDesign;UI;Control Library;Desktop;XAML</PackageTags>
<ProjectUrl>https://qinware.com</ProjectUrl>
<RepositoryUrl>https://github.com/AtomUI/AtomUI</RepositoryUrl>
<Company>Qinware Technologies Ltd.</Company>
@@ -22,4 +22,4 @@
<None Include="$(MSBuildThisFileDirectory)../README.nuget.md" Visible="False" Pack="True" PackagePath="/"/>
</ItemGroup>
</Project>
</Project>
Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

After

Width:  |  Height:  |  Size: 373 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 258 KiB

After

Width:  |  Height:  |  Size: 269 KiB