Add Readmes to each component (#224)

* Add readmes to packages * Added standard readme to each component sample * Sorting items alphabetically * Update components/Collections/src/ReadMe.md * Add PackageReadmeFile directly to csproj files... --------- Co-authored-by: Arlo Godfrey <[email protected]> Co-authored-by: Niels Laute <[email protected]>
CommunityToolkit · Sep 7, 2023 · 201a8fe · 201a8fe
1 parent 241b30a
commit 201a8fe
Show file tree

Hide file tree

Showing 44 changed files with 1,057 additions and 2 deletions.
diff --git a/components/Animations/src/CommunityToolkit.WinUI.Animations.csproj b/components/Animations/src/CommunityToolkit.WinUI.Animations.csproj
@@ -6,6 +6,7 @@
     <!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
     <RootNamespace>CommunityToolkit.WinUI.AnimationsRns</RootNamespace>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -22,6 +23,13 @@
     <ProjectReference Include="$(ToolkitExtensionSourceProject)" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="ReadMe.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <!-- Sets this up as a toolkit component's source project -->
   <Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
 </Project>
diff --git a/components/Animations/src/ReadMe.md b/components/Animations/src/ReadMe.md
@@ -0,0 +1,31 @@
+
+# Windows Community Toolkit - Animations
+
+This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
+
+## Package Contents
+
+This package contains the following in the `CommunityToolkit.WinUI.Animations` namespace:
+
+- AnimationBuilder
+- AnimationSet
+- Connected Animations Helpers
+- Expressions
+- Implicit Animations
+- ScrollViewerExtensions
+
+## Which Package is for me?
+
+If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Animations` package.
+
+If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Animations` package.
+
+## Documentation
+
+Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
+
+## License
+
+MIT
+
+See License.md in package for more details.
diff --git a/components/Behaviors/src/CommunityToolkit.WinUI.Behaviors.csproj b/components/Behaviors/src/CommunityToolkit.WinUI.Behaviors.csproj
@@ -5,11 +5,19 @@
 
     <!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
     <RootNamespace>CommunityToolkit.WinUI.BehaviorsRns</RootNamespace>
+    <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
   </PropertyGroup>
 
   <!-- Sets this up as a toolkit component's source project -->
   <Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
 
+  <ItemGroup>
+    <None Include="ReadMe.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <ItemGroup>
     <ProjectReference Include="$(ToolkitAnimationSourceProject)" />
     <ProjectReference Include="$(ToolkitExtensionSourceProject)" />

diff --git a/components/Behaviors/src/ReadMe.md b/components/Behaviors/src/ReadMe.md
@@ -0,0 +1,39 @@
+
+# Windows Community Toolkit - Behaviors
+
+This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
+
+## Package Contents
+
+This package contains the following in the `CommunityToolkit.WinUI.Behaviors` namespace:
+
+- AnimationCompletedTriggerBehavior
+- AnimationStartedTriggerBehavior
+- AutoSelectBehavior
+- FadeHeaderBehavior
+- FocusBehavior
+- InvokeActionsActivity
+- KeyDownTriggerBehavior
+- NavigateToUriAction
+- QuickReturnHeaderBehavior
+- StartAnimationAction
+- StackedNotificationBehavior
+- StopAnimationAction
+- StickyHeaderBehavior
+- ViewportBehavior
+
+## Which Package is for me?
+
+If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Behaviors` package.
+
+If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Behaviors` package.
+
+## Documentation
+
+Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
+
+## License
+
+MIT
+
+See License.md in package for more details.
diff --git a/components/CameraPreview/src/CommunityToolkit.WinUI.Controls.CameraPreview.csproj b/components/CameraPreview/src/CommunityToolkit.WinUI.Controls.CameraPreview.csproj
@@ -5,6 +5,7 @@
 
     <!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
     <RootNamespace>CommunityToolkit.WinUI.Controls.CameraPreviewRns</RootNamespace>
+    <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -14,6 +15,13 @@
   <!-- Sets this up as a toolkit component's source project -->
   <Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
 
+  <ItemGroup>
+    <None Include="ReadMe.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
    <PropertyGroup>
     <PackageId>$(PackageIdPrefix).$(PackageIdVariant).Controls.$(ToolkitComponentName)</PackageId>
   </PropertyGroup>

diff --git a/components/CameraPreview/src/ReadMe.md b/components/CameraPreview/src/ReadMe.md
@@ -0,0 +1,38 @@
+
+# Windows Community Toolkit - CameraPreview
+
+This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
+
+## Package Contents
+
+This package contains the following controls in the `CommunityToolkit.WinUI.Controls` namespace:
+
+- CameraPreview
+
+## Which Package is for me?
+
+If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Controls.CameraPreview` package.
+
+If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Controls.CameraPreview` package.
+
+## WinUI Resources (UWP)
+
+For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file:
+
+```xml
+    <Application.Resources>
+        <XamlControlsResources xmlns="using:Microsoft.UI.Xaml.Controls" />
+    </Application.Resources>
+```
+
+See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information.
+
+## Documentation
+
+Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
+
+## License
+
+MIT
+
+See License.md in package for more details.
diff --git a/components/Collections/src/CommunityToolkit.WinUI.Collections.csproj b/components/Collections/src/CommunityToolkit.WinUI.Collections.csproj
@@ -5,12 +5,20 @@
 
     <!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
     <RootNamespace>CommunityToolkit.WinUI.CollectionsRns</RootNamespace>
+    <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
     <ProjectReference Include="$(ToolkitHelperSourceProject)"/>
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="ReadMe.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <!-- Sets this up as a toolkit component's source project -->
   <Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
 </Project>
diff --git a/components/Collections/src/ReadMe.md b/components/Collections/src/ReadMe.md
@@ -0,0 +1,27 @@
+
+# Windows Community Toolkit - Collections
+
+This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
+
+## Package Contents
+
+This package contains the following in the `CommunityToolkit.WinUI.Collections` namespace:
+
+- AdvancedCollectionView
+- IncrementalLoadingCollection
+
+## Which Package is for me?
+
+If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Collections` package.
+
+If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Collections` package.
+
+## Documentation
+
+Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
+
+## License
+
+MIT
+
+See License.md in package for more details.
diff --git a/components/Converters/src/CommunityToolkit.WinUI.Converters.csproj b/components/Converters/src/CommunityToolkit.WinUI.Converters.csproj
@@ -5,11 +5,20 @@
 
     <!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
     <RootNamespace>CommunityToolkit.WinUI.ConvertersRns</RootNamespace>
+    <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="ReadMe.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <!-- Sets this up as a toolkit component's source project -->
   <Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
+
   <ItemGroup>
-    <PackageReference Include="CommunityToolkit.Common" Version="8.1.0" />
+    <PackageReference Include="CommunityToolkit.Common" Version="8.2.1" />
   </ItemGroup>
 </Project>
diff --git a/components/Converters/src/ReadMe.md b/components/Converters/src/ReadMe.md
@@ -0,0 +1,43 @@
+
+# Windows Community Toolkit - Converters
+
+This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
+
+## Package Contents
+
+This package contains the following converters in the `CommunityToolkit.WinUI.Converters` namespace:
+
+- BoolNegationConverter
+- BoolToObjectConverter
+- BoolToVisibilityConverter
+- CollectionVisibilityConverter
+- ColorToDisplayNameConverter
+- DoubleToObjectConverter
+- DoubleToVisibilityConverter
+- EmptyCollectionToObjectConverter
+- EmptyObjectToObjectConverter
+- EmptyStringToObjectConverter
+- FileSizeToFriendlyStringConverter
+- IFormattableToStringConverter
+- ResourceNameToResourceStringConverter
+- StringFormatConverter
+- StringVisibilityConverter
+- TaskResultConverter
+- TypeToObjectConverter
+- VisibilityToBoolConverter
+
+## Which Package is for me?
+
+If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.Converters` package.
+
+If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.Converters` package.
+
+## Documentation
+
+Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
+
+## License
+
+MIT
+
+See License.md in package for more details.
diff --git a/components/DeveloperTools/src/CommunityToolkit.WinUI.DeveloperTools.csproj b/components/DeveloperTools/src/CommunityToolkit.WinUI.DeveloperTools.csproj
@@ -5,8 +5,16 @@
 
     <!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
     <RootNamespace>CommunityToolkit.WinUI.DeveloperToolsRns</RootNamespace>
+    <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="ReadMe.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
   <!-- Sets this up as a toolkit component's source project -->
   <Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
 </Project>
diff --git a/components/DeveloperTools/src/ReadMe.md b/components/DeveloperTools/src/ReadMe.md
@@ -0,0 +1,39 @@
+
+# Windows Community Toolkit - DeveloperTools
+
+This package is part of the [Windows Community Toolkit](https://aka.ms/toolkit/windows) from the [.NET Foundation](https://dotnetfoundation.org).
+
+## Package Contents
+
+This package contains the following controls in the `CommunityToolkit.WinUI.DeveloperTools` namespace:
+
+- AlignmentGrid
+- FocusTracker
+
+## Which Package is for me?
+
+If you're developing with _UWP/WinUI 2 or Uno.UI_ you should be using the `CommunityToolkit.Uwp.DeveloperTools` package.
+
+If you're developing with _WindowsAppSDK/WinUI 3 or Uno.WinUI_ you should be using the `CommunityToolkit.WinUI.DeveloperTools` package.
+
+## WinUI Resources (UWP)
+
+For UWP projects, the WinUI 2 reference requires you include the WinUI XAML Resources in your App.xaml file:
+
+```xml
+    <Application.Resources>
+        <XamlControlsResources xmlns="using:Microsoft.UI.Xaml.Controls" />
+    </Application.Resources>
+```
+
+See [Getting Started in WinUI 2](https://learn.microsoft.com/windows/apps/winui/winui2/getting-started) for more information.
+
+## Documentation
+
+Further documentation about these components can be found at: https://aka.ms/windowstoolkitdocs
+
+## License
+
+MIT
+
+See License.md in package for more details.
diff --git a/components/Extensions/src/CommunityToolkit.WinUI.Extensions.csproj b/components/Extensions/src/CommunityToolkit.WinUI.Extensions.csproj
@@ -6,13 +6,21 @@
     <!-- Rns suffix is required for namespaces shared across projects. See https://github.com/CommunityToolkit/Labs-Windows/issues/152 -->
     <RootNamespace>CommunityToolkit.WinUI.ExtensionsRns</RootNamespace>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
+    <PackageReadmeFile>ReadMe.md</PackageReadmeFile>
   </PropertyGroup>
 
   <!-- Sets this up as a toolkit component's source project -->
   <Import Project="$(ToolingDirectory)\ToolkitComponent.SourceProject.props" />
 
   <ItemGroup>
-    <PackageReference Include="CommunityToolkit.Common" Version="8.1.0" />
+    <None Include="ReadMe.md">
+      <Pack>True</Pack>
+      <PackagePath>\</PackagePath>
+    </None>
+  </ItemGroup>
+
+  <ItemGroup>
+    <PackageReference Include="CommunityToolkit.Common" Version="8.2.1" />
 
     <PackageReference Include="PolySharp" Version="1.13.1">
       <PrivateAssets>all</PrivateAssets>