diff --git a/README.md b/README.md index 6d346ae..c6ae7f0 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ -# Semi.Avalonia +# Semi Avalonia [![Semi Avalonia](https://img.shields.io/nuget/v/Semi.Avalonia.svg?color=red&style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/) [![Semi Avalonia](https://img.shields.io/nuget/dt/Semi.Avalonia.svg?style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/) +[中文](./README_CN.md) + Avalonia Theme inspired by Semi Design -# How to Use +If you are looking for more customized controls, Please try [Ursa](https://github.com/irihitech/Ursa.Avalonia) + +![Light](./docs/demo.jpg) + +## How to Use + +### Installation -## Installation ```bash dotnet add package Semi.Avalonia --version 11.0.7 ``` + Include Semi Design Styles in application: ```xaml @@ -19,14 +27,16 @@ Include Semi Design Styles in application: ``` -That's all. +That's all. ColorPicker, DataGrid and TreeDataGrid are distributed in separated packages. Please install if you need. + ```bash dotnet add package Semi.Avalonia.ColorPicker --version 11.0.7 dotnet add package Semi.Avalonia.DataGrid --version 11.0.7 dotnet add package Semi.Avalonia.TreeDataGrid --version 11.0.7 ``` + ```xaml @@ -38,7 +48,7 @@ dotnet add package Semi.Avalonia.TreeDataGrid --version 11.0.7 ## Demo You can always download demo executable to play around with Semi Avalonia Themes. -https://github.com/irihitech/Semi.Avalonia/releases + ## Version compatibility @@ -48,6 +58,7 @@ https://github.com/irihitech/Semi.Avalonia/releases | 11.0.1 | <=11.0.6 | ## TODO + * FocusAdorner ## Credits @@ -62,10 +73,3 @@ https://github.com/irihitech/Semi.Avalonia/releases [CommunityToolKit](https://github.com/CommunityToolkit/dotnet) -## Screenshot - -Light Mode -![Light](./docs/Light.png) - -Dark Mode -![Dark](./docs/Dark.png) \ No newline at end of file diff --git a/README_CN.md b/README_CN.md new file mode 100644 index 0000000..14b9cd5 --- /dev/null +++ b/README_CN.md @@ -0,0 +1,76 @@ +# Semi Avalonia + +[![Semi Avalonia](https://img.shields.io/nuget/v/Semi.Avalonia.svg?color=red&style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/) +[![Semi Avalonia](https://img.shields.io/nuget/dt/Semi.Avalonia.svg?style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/) + +[English](./README.md) + +Avalonia UI 控件主题,灵感来自 Semi Design + +如果您希望使用更多的拓展控件,欢迎尝试 [Ursa](https://github.com/irihitech/Ursa.Avalonia) + +![Light](./docs/demo.jpg) + +## 如何使用 + +### 安装 + +```bash +dotnet add package Semi.Avalonia --version 11.0.7 +``` + +在样式中引用 Semi 主题: + +```xaml + + + +``` + +这样就可以了。 + +ColorPicker, DataGrid 和 TreeDataGrid 的样式单独分发,如果需要请安装并引用。 + +```bash +dotnet add package Semi.Avalonia.ColorPicker --version 11.0.7 +dotnet add package Semi.Avalonia.DataGrid --version 11.0.7 +dotnet add package Semi.Avalonia.TreeDataGrid --version 11.0.7 +``` + +```xaml + + + + + +``` + +## 示例 + +您可以从 Semi Avalonia 的 release 页下载并试用 Semi Avalonia 的展示应用。 + + + +## 版本兼容性 + +| Semi Design Version | Avalonia Version | +|:--------------------|:-----------------| +| 11.0.7 | >=11.0.7 | +| 11.0.1 | <=11.0.6 | + +## 代办事项 + +* FocusAdorner + +## 致谢 + +[Semi Design](https://semi.design/) + +[Avalonia](https://github.com/AvaloniaUI/Avalonia) + +[FluentAvalonia](https://github.com/amwx/FluentAvalonia) + +[Material Design Icons](https://pictogrammers.com/library/mdi/) + +[CommunityToolKit](https://github.com/CommunityToolkit/dotnet) + diff --git a/docs/demo.jpg b/docs/demo.jpg new file mode 100644 index 0000000..1d98841 Binary files /dev/null and b/docs/demo.jpg differ