From ab2cef9dc477698921e9fe57b841ce9617a21b64 Mon Sep 17 00:00:00 2001
From: Copilot <198982749+Copilot@users.noreply.github.com>
Date: Thu, 9 Oct 2025 19:47:10 +0800
Subject: [PATCH] Add README files to NuGet packages (#677)

* Initial plan

* Add README files to NuGet packages for Semi.Avalonia, Semi.Avalonia.DataGrid, and Semi.Avalonia.ColorPicker

Co-authored-by: rabbitism <14807942+rabbitism@users.noreply.github.com>

* Restore Package.props import to reduce code duplication

Co-authored-by: rabbitism <14807942+rabbitism@users.noreply.github.com>

* Add README file to Semi.Avalonia.TreeDataGrid package

Co-authored-by: zdpcdt <54255897+zdpcdt@users.noreply.github.com>

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: rabbitism <14807942+rabbitism@users.noreply.github.com>
Co-authored-by: zdpcdt <54255897+zdpcdt@users.noreply.github.com>
---
 src/Package.props                             |  1 +
 src/Semi.Avalonia.ColorPicker/README.md       | 49 +++++++++++++
 .../Semi.Avalonia.ColorPicker.csproj          |  1 +
 src/Semi.Avalonia.DataGrid/README.md          | 49 +++++++++++++
 .../Semi.Avalonia.DataGrid.csproj             |  2 +
 src/Semi.Avalonia.TreeDataGrid/README.md      | 49 +++++++++++++
 .../Semi.Avalonia.TreeDataGrid.csproj         |  2 +
 src/Semi.Avalonia/README.MD                   | 26 -------
 src/Semi.Avalonia/README.md                   | 71 +++++++++++++++++++
 src/Semi.Avalonia/Semi.Avalonia.csproj        |  1 +
 10 files changed, 225 insertions(+), 26 deletions(-)
 create mode 100644 src/Semi.Avalonia.ColorPicker/README.md
 create mode 100644 src/Semi.Avalonia.DataGrid/README.md
 create mode 100644 src/Semi.Avalonia.TreeDataGrid/README.md
 delete mode 100644 src/Semi.Avalonia/README.MD
 create mode 100644 src/Semi.Avalonia/README.md

diff --git a/src/Package.props b/src/Package.props
index 081a5b0..df8a850 100644
--- a/src/Package.props
+++ b/src/Package.props
@@ -12,6 +12,7 @@
         <PackageProjectUrl>https://github.com/irihitech/Semi.Avalonia</PackageProjectUrl>
         <AvaloniaVersion>11.3.7</AvaloniaVersion>
         <AvaloniaUseCompiledBindingsByDefault>true</AvaloniaUseCompiledBindingsByDefault>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <ItemGroup>
diff --git a/src/Semi.Avalonia.ColorPicker/README.md b/src/Semi.Avalonia.ColorPicker/README.md
new file mode 100644
index 0000000..6aeff9e
--- /dev/null
+++ b/src/Semi.Avalonia.ColorPicker/README.md
@@ -0,0 +1,49 @@
+# Semi.Avalonia.ColorPicker
+
+[![Semi Avalonia](https://img.shields.io/nuget/v/Semi.Avalonia.svg?color=red&style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/)
+
+Avalonia ColorPicker Theme inspired by Semi Design
+
+This package provides Semi Design theming for the Avalonia ColorPicker control.
+
+## Installation
+
+```bash
+dotnet add package Semi.Avalonia.ColorPicker
+```
+
+## Prerequisites
+
+This package requires the main Semi.Avalonia theme to be installed:
+
+```bash
+dotnet add package Semi.Avalonia
+```
+
+## Usage
+
+Include the ColorPicker theme in your application:
+
+```xaml
+<Application
+    ...
+    xmlns:semi="https://irihi.tech/semi">
+    <Application.Styles>
+        <semi:SemiTheme Locale="zh-CN" />
+        <semi:ColorPickerSemiTheme />
+    </Application.Styles>
+</Application>
+```
+
+## Resources
+
+- [Documentation](https://docs.irihi.tech/semi/)
+- [Repository](https://github.com/irihitech/Semi.Avalonia)
+- [Online Demo](https://irihitech.github.io/Semi.Avalonia/)
+- [Download Demo](https://github.com/irihitech/Semi.Avalonia/releases)
+
+## Credits
+
+[Semi Design](https://semi.design/)
+
+[Avalonia](https://github.com/AvaloniaUI/Avalonia)
diff --git a/src/Semi.Avalonia.ColorPicker/Semi.Avalonia.ColorPicker.csproj b/src/Semi.Avalonia.ColorPicker/Semi.Avalonia.ColorPicker.csproj
index 99920dc..1e824f8 100644
--- a/src/Semi.Avalonia.ColorPicker/Semi.Avalonia.ColorPicker.csproj
+++ b/src/Semi.Avalonia.ColorPicker/Semi.Avalonia.ColorPicker.csproj
@@ -13,6 +13,7 @@
 
     <ItemGroup>
         <PackageReference Include="Avalonia.Controls.ColorPicker" Version="$(AvaloniaVersion)"/>
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Semi.Avalonia.DataGrid/README.md b/src/Semi.Avalonia.DataGrid/README.md
new file mode 100644
index 0000000..5335b85
--- /dev/null
+++ b/src/Semi.Avalonia.DataGrid/README.md
@@ -0,0 +1,49 @@
+# Semi.Avalonia.DataGrid
+
+[![Semi Avalonia](https://img.shields.io/nuget/v/Semi.Avalonia.svg?color=red&style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/)
+
+Avalonia DataGrid Theme inspired by Semi Design
+
+This package provides Semi Design theming for the Avalonia DataGrid control.
+
+## Installation
+
+```bash
+dotnet add package Semi.Avalonia.DataGrid
+```
+
+## Prerequisites
+
+This package requires the main Semi.Avalonia theme to be installed:
+
+```bash
+dotnet add package Semi.Avalonia
+```
+
+## Usage
+
+Include the DataGrid theme in your application:
+
+```xaml
+<Application
+    ...
+    xmlns:semi="https://irihi.tech/semi">
+    <Application.Styles>
+        <semi:SemiTheme Locale="zh-CN" />
+        <semi:DataGridSemiTheme />
+    </Application.Styles>
+</Application>
+```
+
+## Resources
+
+- [Documentation](https://docs.irihi.tech/semi/)
+- [Repository](https://github.com/irihitech/Semi.Avalonia)
+- [Online Demo](https://irihitech.github.io/Semi.Avalonia/)
+- [Download Demo](https://github.com/irihitech/Semi.Avalonia/releases)
+
+## Credits
+
+[Semi Design](https://semi.design/)
+
+[Avalonia](https://github.com/AvaloniaUI/Avalonia)
diff --git a/src/Semi.Avalonia.DataGrid/Semi.Avalonia.DataGrid.csproj b/src/Semi.Avalonia.DataGrid/Semi.Avalonia.DataGrid.csproj
index 923a57e..f11d106 100644
--- a/src/Semi.Avalonia.DataGrid/Semi.Avalonia.DataGrid.csproj
+++ b/src/Semi.Avalonia.DataGrid/Semi.Avalonia.DataGrid.csproj
@@ -13,6 +13,7 @@
         <PackageIcon>irihi.png</PackageIcon>
         <PackageProjectUrl>https://github.com/irihitech/Semi.Avalonia</PackageProjectUrl>
         <Title>Semi.Avalonia.DataGrid</Title>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <PropertyGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">
@@ -23,6 +24,7 @@
         <PackageReference Include="Avalonia.Controls.DataGrid" Version="11.3.7"/>
         <None Include="..\..\irihi.png" Pack="true" PackagePath="\" Link="Properties\irihi.png"/>
         <None Include="..\..\LICENSE" Pack="true" PackagePath="\" Link="Properties\LICENSE"/>
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Semi.Avalonia.TreeDataGrid/README.md b/src/Semi.Avalonia.TreeDataGrid/README.md
new file mode 100644
index 0000000..276b2db
--- /dev/null
+++ b/src/Semi.Avalonia.TreeDataGrid/README.md
@@ -0,0 +1,49 @@
+# Semi.Avalonia.TreeDataGrid
+
+[![Semi Avalonia](https://img.shields.io/nuget/v/Semi.Avalonia.svg?color=red&style=flat-square)](https://www.nuget.org/packages/Semi.Avalonia/)
+
+Avalonia TreeDataGrid Theme inspired by Semi Design
+
+This package provides Semi Design theming for the Avalonia TreeDataGrid control.
+
+## Installation
+
+```bash
+dotnet add package Semi.Avalonia.TreeDataGrid
+```
+
+## Prerequisites
+
+This package requires the main Semi.Avalonia theme to be installed:
+
+```bash
+dotnet add package Semi.Avalonia
+```
+
+## Usage
+
+Include the TreeDataGrid theme in your application:
+
+```xaml
+<Application
+    ...
+    xmlns:semi="https://irihi.tech/semi">
+    <Application.Styles>
+        <semi:SemiTheme Locale="zh-CN" />
+        <semi:TreeDataGridSemiTheme />
+    </Application.Styles>
+</Application>
+```
+
+## Resources
+
+- [Documentation](https://docs.irihi.tech/semi/)
+- [Repository](https://github.com/irihitech/Semi.Avalonia)
+- [Online Demo](https://irihitech.github.io/Semi.Avalonia/)
+- [Download Demo](https://github.com/irihitech/Semi.Avalonia/releases)
+
+## Credits
+
+[Semi Design](https://semi.design/)
+
+[Avalonia](https://github.com/AvaloniaUI/Avalonia)
diff --git a/src/Semi.Avalonia.TreeDataGrid/Semi.Avalonia.TreeDataGrid.csproj b/src/Semi.Avalonia.TreeDataGrid/Semi.Avalonia.TreeDataGrid.csproj
index ce67cc2..3f15cee 100644
--- a/src/Semi.Avalonia.TreeDataGrid/Semi.Avalonia.TreeDataGrid.csproj
+++ b/src/Semi.Avalonia.TreeDataGrid/Semi.Avalonia.TreeDataGrid.csproj
@@ -12,6 +12,7 @@
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageIcon>irihi.png</PackageIcon>
         <PackageProjectUrl>https://github.com/irihitech/Semi.Avalonia</PackageProjectUrl>
+        <PackageReadmeFile>README.md</PackageReadmeFile>
     </PropertyGroup>
 
     <PropertyGroup Condition="$([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0'))">
@@ -22,6 +23,7 @@
         <PackageReference Include="Avalonia.Controls.TreeDataGrid" Version="11.0.10"/>
         <None Include="..\..\irihi.png" Pack="true" PackagePath="\" Link="Properties\irihi.png"/>
         <None Include="..\..\LICENSE" Pack="true" PackagePath="\" Link="Properties\LICENSE"/>
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>
diff --git a/src/Semi.Avalonia/README.MD b/src/Semi.Avalonia/README.MD
deleted file mode 100644
index 3acff27..0000000
--- a/src/Semi.Avalonia/README.MD
+++ /dev/null
@@ -1,26 +0,0 @@
-# Semi.Avalonia Theme 
-
-## Naming Conventions
-
-Resources are named by following format
-
-`Control`+`Theme`[+`Class`+`PseudoClass`]+`Property`
-
-Example:
-
-`ButtonDefaultBackground`
-
-`ButtonSolidPointeroverBorderThickness`
-
-### Theme
-
-If Theme key is type default, use `Default` as Theme part
-
-### Class and PseudoClass
-
-* Classes comes before PseudoClasses
-
-* If multiple Classes are applied, order by alphabet order.
-
-* If multiple PseudoClass are applied, order by alphabet order.
-
diff --git a/src/Semi.Avalonia/README.md b/src/Semi.Avalonia/README.md
new file mode 100644
index 0000000..e7522ca
--- /dev/null
+++ b/src/Semi.Avalonia/README.md
@@ -0,0 +1,71 @@
+# 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/)
+
+Avalonia Theme inspired by Semi Design
+
+## Installation
+
+```bash
+dotnet add package Semi.Avalonia
+```
+
+## Usage
+
+Include Semi Design Styles in your application:
+
+```xaml
+<Application
+    ...
+    xmlns:semi="https://irihi.tech/semi">
+    <Application.Styles>
+        <semi:SemiTheme Locale="zh-CN" />
+    </Application.Styles>
+</Application>
+```
+
+That's all.
+
+## Additional Packages
+
+ColorPicker, DataGrid, TreeDataGrid, Dock, Tabalonia and AvaloniaEdit are distributed in separated packages. Please install if you need.
+
+```bash
+dotnet add package Semi.Avalonia.ColorPicker
+dotnet add package Semi.Avalonia.DataGrid
+dotnet add package Semi.Avalonia.TreeDataGrid
+dotnet add package Semi.Avalonia.Dock
+dotnet add package Semi.Avalonia.Tabalonia
+dotnet add package Semi.Avalonia.AvaloniaEdit
+```
+
+```xaml
+<Application.Styles>
+    <semi:ColorPickerSemiTheme />
+    <semi:DataGridSemiTheme />
+    <semi:TreeDataGridSemiTheme />
+    <semi:DockSemiTheme />
+    <semi:TabaloniaSemiTheme />
+    <semi:AvaloniaEditSemiTheme />
+</Application.Styles>
+```
+
+## Resources
+
+- [Documentation](https://docs.irihi.tech/semi/)
+- [Repository](https://github.com/irihitech/Semi.Avalonia)
+- [Online Demo](https://irihitech.github.io/Semi.Avalonia/)
+- [Download Demo](https://github.com/irihitech/Semi.Avalonia/releases)
+
+## Credits
+
+[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/src/Semi.Avalonia/Semi.Avalonia.csproj b/src/Semi.Avalonia/Semi.Avalonia.csproj
index 36e6ea3..f47a074 100644
--- a/src/Semi.Avalonia/Semi.Avalonia.csproj
+++ b/src/Semi.Avalonia/Semi.Avalonia.csproj
@@ -13,6 +13,7 @@
 
     <ItemGroup>
         <PackageReference Include="Avalonia" Version="$(AvaloniaVersion)"/>
+        <None Include="README.md" Pack="true" PackagePath="\" />
     </ItemGroup>
 
 </Project>