Add README.md file to nuget package

hexinnovation · Jun 17, 2023 · 8e3193a · 8e3193a
1 parent d9bdd10
commit 8e3193a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 0 deletions.
diff --git a/Nuget README.md b/Nuget README.md
@@ -0,0 +1,42 @@
+[![Math Converter: A XAML Converter that does it all.](https://raw.githubusercontent.com/hexinnovation/MathConverter/main/ReadmeAssets/Banner.svg)](https://github.com/hexinnovation/MathConverter)
+
+What is MathConverter?
+----------------------
+
+`MathConverter` allows you to do Math in XAML.
+
+`MathConverter` is a powerful `Binding` converter that allows you to specify how to perform conversions directly in XAML, without needing to define a new `IValueConverter` in C# for every single conversion.
+
+Getting Started:
+----------------
+
+It's as easy as 1-2-3.
+
+**1)** Install the Nuget package.
+
+**2)** Add a `MathConverter` resource.
+
+```xaml
+<Application.Resources>
+    <math:MathConverter x:Key="Math" />
+</Application.Resources>
+```
+
+The `math` namespace is defined as follows<b>*</b>:
+
+```xaml
+xmlns:math="http://hexinnovation.com/math"
+```
+
+**3)** Do Math. Now, you can use `MathConverter` on any `Binding`. Specify a `ConverterParameter` to specify the rules of the conversion.
+
+```xaml
+<Border.CornerRadius>
+    <MultiBinding ConverterParameter="Min(x,y)/2" Converter="{StaticResource Math}">
+        <Binding Path="ActualHeight" />
+        <Binding Path="ActualWidth" />
+    </MultiBinding>
+</Border.CornerRadius>
+```
+
+See [the GitHub repository](https://github.com/hexinnovation/MathConverter) for documentation and examples.
diff --git a/src/MathConverter.sln b/src/MathConverter.sln
@@ -8,6 +8,7 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "MathConverter.Demo.WPF", "D
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Readme", "Readme", "{7F4CC393-A1F5-4591-90E9-F299D83549D9}"
 	ProjectSection(SolutionItems) = preProject
+		..\Nuget README.md = ..\Nuget README.md
 		..\README.md = ..\README.md
 	EndProjectSection
 EndProject

diff --git a/src/Projects/Common/App.props b/src/Projects/Common/App.props
@@ -16,6 +16,7 @@
     <PackageIcon>smalllogo.png</PackageIcon>
     <RepositoryType>GitHub</RepositoryType>
     <PackageTags>$(PackageTags) Converter Math Arbitrary Expressions XAML ConverterParameter IValueConverter IMultiValueConverter</PackageTags>
+    <PackageReadmeFile Condition="'$(MSBuildRuntimeType)' != 'Mono'">README.md</PackageReadmeFile>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <IncludeSymbols>true</IncludeSymbols>
@@ -30,6 +31,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
     <None Include="$(MSBuildThisFileDirectory)..\..\..\ReadmeAssets\smalllogo.png" Pack="True" PackagePath="smalllogo.png" Link="Assets\smalllogo.png" />
+    <None Include="$(MSBuildThisFileDirectory)..\..\..\Nuget README.md" Pack="True" PackagePath="README.md" Link="Assets\README.md" />
     <EmbeddedFiles Include="$(GeneratedAssemblyInfoFile)" />
   </ItemGroup>