diff --git a/CommunityToolkit-Header.png b/CommunityToolkit-Header.png deleted file mode 100644 index ecde731b..00000000 Binary files a/CommunityToolkit-Header.png and /dev/null differ diff --git a/ReadMe.md b/ReadMe.md index 45c10824..ff73e428 100644 --- a/ReadMe.md +++ b/ReadMe.md @@ -1,31 +1,62 @@ +

+Windows Community Toolkit Gallery +

-# Windows Community Toolkit 🧰 +

+ Windows Community Toolkit +

-![Windows Community Toolkit Labs Social Image](CommunityToolkit-Header.png) +

+ Documentation + · + Labs + · + Tooling +

-Welcome to the home of Windows Community Toolkit. Our components are built on top of [WinUI 2](https://aka.ms/winuigithub), [WinUI 3](https://aka.ms/winui3), and [Uno Platform](https://platform.uno)! +The Windows Community Toolkit is a rich set of controls, helpers and extensions designed to streamline Windows app development and to create great experiences for Windows. Our components are built on top of [WinUI 2](https://aka.ms/winuigithub), [WinUI 3](https://aka.ms/winui3), and [Uno Platform](https://platform.uno)! -They enable developers to build great experiences for Windows with .NET! +Please read the [Getting Started with the Windows Community Toolkit](https://docs.microsoft.com/dotnet/communitytoolkit/windows/getting-started) page for more detailed information about using the Toolkit in your app. -_Building something cool? Want to engage with other developers? Want to contribute to the Toolkit? **[Engage in the discussion here!](https://github.com/CommunityToolkit/Windows/discussions)**_ +> [!NOTE] +> If you're updating from a pre-8.x version of the Windows Community Toolkit, see [our migration notes here](https://aka.ms/toolkit/windows/migration). -## Getting Started +## Windows Community Toolkit Gallery app -### [Try out our Sample Gallery from the Microsoft Store](https://aka.ms/windowstoolkitapp) +Want to see the Toolkit in action before jumping into the code? Download and play with the [Windows Community Toolkit Gallery](https://aka.ms/windowstoolkitapp) from the Microsoft Store. -Want to see the toolkit in action before jumping into the code? Download and play with the [Windows Community Toolkit Gallery](https://aka.ms/windowstoolkitapp) from the Store. +

+Windows Community Toolkit Gallery +

+

+ + Store badge + +

-Please read the [Getting Started with the Windows Community Toolkit](https://docs.microsoft.com/dotnet/communitytoolkit/windows/getting-started) page for more detailed information about using the toolkit. -If you're updating from a pre-8.x version of the Windows Community Toolkit, see [our migration notes here](https://aka.ms/toolkit/windows/migration). -### Windows Community Toolkit Labs -Have an idea for a new feature? Want to checkout the latest things being built. _[Then head over to Windows Community Toolkit Labs](https://aka.ms/toolkit/labs/windows)_. +## 👏 Contribute to the Windows Community Toolkit -You can even see the latest components [live in your browser!](https://toolkitlabs.dev) +Have an idea for a new feature? Want to checkout the latest things being built? [Then head over to Windows Community Toolkit Labs](https://aka.ms/toolkit/labs/windows). -## Clone the repository +Building something cool? Want to engage with other developers? Want to contribute to the Toolkit? **[Engage in the discussion here!](https://github.com/CommunityToolkit/Windows/discussions)** + +## 📋 Getting started with Windows Community Toolkit + +### 1. Set up the environment + +> [!NOTE] +> The Windows Community Toolkit requires [Visual Studio 2022](https://visualstudio.microsoft.com/vs/) or later to build and Windows 10 or later to execute. If you're building an app with WinUI and Windows App SDK for the first time, follow these [installation instructions](https://learn.microsoft.com/windows/apps/get-started/start-here). + +**Required [Visual Studio components](https://learn.microsoft.com/windows/apps/get-started/start-here?tabs=vs-2022-17-10#required-workloads-and-components):** +- Windows application development +- .NET desktop development +- Windows 10 SDK, version 2004 (10.0.19041.0) +- Windows 10 21H1 (Build 19043) or greater + +### 2. Clone the repository The [tooling](https://github.com/CommunityToolkit/Tooling-Windows-Submodule) is in a submodule, so you'll need to use `--recurse-submodules` when cloning or pulling for the first time: @@ -33,15 +64,11 @@ The [tooling](https://github.com/CommunityToolkit/Tooling-Windows-Submodule) is git clone --recurse-submodules https://github.com/CommunityToolkit/Windows.git ``` -## Build Requirements - -- Visual Studio 2022 (UWP & Desktop Workloads for .NET) -- .NET 8 SDK -- Windows 10 SDK, version 2004 (10.0.19041.0) -- Windows 10 21H1 (Build 19043) or greater +### 3. Run build scripts & open solution - Run `dotnet tool restore` from the project root to install SlnGen - Run build scripts from the [Developer Command Prompt for Visual Studio](https://learn.microsoft.com/visualstudio/ide/reference/command-prompt-powershell) or from elsewhere after adding `MSBuild.exe` to your PATH + ## 🚀 Contribution We're always looking for a helping hand, [look for issues that we need help with here](https://github.com/CommunityToolkit/Windows/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or head over to [Windows Community Toolkit Labs](https://aka.ms/toolkit/labs/windows) to try or build new features. @@ -50,7 +77,7 @@ Even just improving our docs and samples for existing components here, or adding Check out our [Windows Community Toolkit Wiki](https://aka.ms/wct/wiki) page to learn more about contribution and guidelines in general (to be updated more soon). -## 📦 NuGet Packages +## 📦 NuGet packages NuGet is a standard package manager for .NET applications which is built into Visual Studio. When you open solution in Visual Studio, choose the *Tools* menu > *NuGet Package Manager* > *Manage NuGet packages for solution…* @@ -59,9 +86,6 @@ There are now two sets of packages for each component: - `CommunityToolkit.Uwp.*` for UWP + WinUI 2 or Uno.UI - `CommunityToolkit.WinUI.*` for Windows App SDK + WinUI 3 or Uno.WinUI -## 📫 Features - -Most features should work with the October 2018 Update (1809) SDK 17763 and above; however, refer to specific documentation on each feature for more information. ## 💠 Principles diff --git a/docs/images/gallery.png b/docs/images/gallery.png new file mode 100644 index 00000000..96c60da1 Binary files /dev/null and b/docs/images/gallery.png differ diff --git a/docs/images/storeBadge.png b/docs/images/storeBadge.png new file mode 100644 index 00000000..b47a5ab8 Binary files /dev/null and b/docs/images/storeBadge.png differ diff --git a/docs/images/wct.png b/docs/images/wct.png new file mode 100644 index 00000000..191b92f0 Binary files /dev/null and b/docs/images/wct.png differ