Skip to content

Commit 591266f

Browse files
authored
Updated readme (#652)
* Updated readme * Update ReadMe.md * Fixes * More fixes
1 parent 00586c1 commit 591266f

File tree

5 files changed

+48
-24
lines changed

5 files changed

+48
-24
lines changed

CommunityToolkit-Header.png

-458 KB
Binary file not shown.

ReadMe.md

+48-24
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,74 @@
1+
<p align="center">
2+
<img src="docs/images/wct.png" alt="Windows Community Toolkit Gallery"/>
3+
</p>
14

2-
# Windows Community Toolkit 🧰
5+
<h1 align="center">
6+
Windows Community Toolkit
7+
</h1>
38

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

6-
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)!
17+
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)!
718

8-
They enable developers to build great experiences for Windows with .NET!
19+
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.
920

10-
_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)**_
21+
> [!NOTE]
22+
> 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).
1123
12-
## Getting Started
24+
## Windows Community Toolkit Gallery app
1325

14-
### [Try out our Sample Gallery from the Microsoft Store](https://aka.ms/windowstoolkitapp)
26+
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.
1527

16-
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.
28+
<p align="center">
29+
<img src="docs/images/gallery.png" alt="Windows Community Toolkit Gallery" width="480"/>
30+
</p>
31+
<p align="center">
32+
<a href="https://aka.ms/windowstoolkitapp">
33+
<img alt="Store badge" src="docs/images/storeBadge.png" width="200"/>
34+
</a>
35+
</p>
1736

18-
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.
1937

20-
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).
2138

22-
### Windows Community Toolkit Labs
2339

24-
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)_.
40+
## 👏 Contribute to the Windows Community Toolkit
2541

26-
You can even see the latest components [live in your browser!](https://toolkitlabs.dev)
42+
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).
2743

28-
## Clone the repository
44+
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)**
45+
46+
## 📋 Getting started with Windows Community Toolkit
47+
48+
### 1. Set up the environment
49+
50+
> [!NOTE]
51+
> 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).
52+
53+
**Required [Visual Studio components](https://learn.microsoft.com/windows/apps/get-started/start-here?tabs=vs-2022-17-10#required-workloads-and-components):**
54+
- Windows application development
55+
- .NET desktop development
56+
- Windows 10 SDK, version 2004 (10.0.19041.0)
57+
- Windows 10 21H1 (Build 19043) or greater
58+
59+
### 2. Clone the repository
2960

3061
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:
3162

3263
```shell
3364
git clone --recurse-submodules https://github.com/CommunityToolkit/Windows.git
3465
```
3566

36-
## Build Requirements
37-
38-
- Visual Studio 2022 (UWP & Desktop Workloads for .NET)
39-
- .NET 8 SDK
40-
- Windows 10 SDK, version 2004 (10.0.19041.0)
41-
- Windows 10 21H1 (Build 19043) or greater
67+
### 3. Run build scripts & open solution
4268
- Run `dotnet tool restore` from the project root to install SlnGen
4369
- 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
4470

71+
4572
## 🚀 Contribution
4673

4774
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
5077

5178
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).
5279

53-
## 📦 NuGet Packages
80+
## 📦 NuGet packages
5481

5582
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…*
5683

@@ -59,9 +86,6 @@ There are now two sets of packages for each component:
5986
- `CommunityToolkit.Uwp.*` for UWP + WinUI 2 or Uno.UI
6087
- `CommunityToolkit.WinUI.*` for Windows App SDK + WinUI 3 or Uno.WinUI
6188

62-
## 📫 Features <a name="supported"></a>
63-
64-
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.
6589

6690
## 💠 Principles
6791

docs/images/gallery.png

178 KB
Loading

docs/images/storeBadge.png

6.2 KB
Loading

docs/images/wct.png

195 KB
Loading

0 commit comments

Comments
 (0)