Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated readme #652

Merged
merged 4 commits into from
Mar 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed CommunityToolkit-Header.png
Binary file not shown.
72 changes: 48 additions & 24 deletions ReadMe.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,74 @@
<p align="center">
<img src="docs/images/wct.png" alt="Windows Community Toolkit Gallery"/>
</p>

# Windows Community Toolkit 🧰
<h1 align="center">
Windows Community Toolkit
</h1>

![Windows Community Toolkit Labs Social Image](CommunityToolkit-Header.png)
<h3 align="center">
<a href="https://docs.microsoft.com/dotnet/communitytoolkit/windows/getting-started">Documentation</a>
<span> · </span>
<a href="https://aka.ms/toolkit/labs/windows">Labs</a>
<span> · </span>
<a href="https://github.com/CommunityToolkit/Tooling-Windows-Submodule">Tooling</a>
</h3>

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.
<p align="center">
<img src="docs/images/gallery.png" alt="Windows Community Toolkit Gallery" width="480"/>
</p>
<p align="center">
<a href="https://aka.ms/windowstoolkitapp">
<img alt="Store badge" src="docs/images/storeBadge.png" width="200"/>
</a>
</p>

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:

```shell
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.
Expand All @@ -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…*

Expand All @@ -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 <a name="supported"></a>

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

Expand Down
Binary file added docs/images/gallery.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/storeBadge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/wct.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading