Update README with .NET MAUI app creation instructions#31738
Merged
Conversation
Added instructions for creating a new .NET MAUI app and using the Syncfusion Toolkit.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds instructions for creating new .NET MAUI applications directly to the README, providing developers with immediate guidance on getting started with the framework. The addition includes both basic app creation and a more comprehensive sample that incorporates popular community toolkits.
- Added command-line instructions for creating new .NET MAUI apps
- Included reference to a sample app template with integrated toolkits
- Enhanced the README with practical getting-started information
README.md
Outdated
Comment on lines
+14
to
+15
| Create a new app with `dotnet new maui -n NewApp` or a [sample app](https://github.com/dotnet/maui-samples/tree/main/10.0/Apps/DeveloperBalance#developer-balance) with `dotnet new maui -NewApp -sc` that includes the [open-source Syncfusion Toolkit for .NET MAUI](https://www.syncfusion.com/net-maui-toolkit?utm_source=msftdotnet&utm_medium=banner&utm_campaign=mauipremium_sep25) with over 30 additional controls, the [.NET MAUI Community Toolkit](https://github.com/CommunityToolkit/Maui) with tons of helpers and views, and [MVVM Toolkit](https://github.com/CommunityToolkit/dotnet). | ||
|
|
There was a problem hiding this comment.
[nitpick] This line is extremely long (over 400 characters) and difficult to read. Consider breaking it into multiple sentences or using a bulleted list to improve readability and maintainability.
Suggested change
| Create a new app with `dotnet new maui -n NewApp` or a [sample app](https://github.com/dotnet/maui-samples/tree/main/10.0/Apps/DeveloperBalance#developer-balance) with `dotnet new maui -NewApp -sc` that includes the [open-source Syncfusion Toolkit for .NET MAUI](https://www.syncfusion.com/net-maui-toolkit?utm_source=msftdotnet&utm_medium=banner&utm_campaign=mauipremium_sep25) with over 30 additional controls, the [.NET MAUI Community Toolkit](https://github.com/CommunityToolkit/Maui) with tons of helpers and views, and [MVVM Toolkit](https://github.com/CommunityToolkit/dotnet). | |
| You can get started in several ways: | |
| * Create a new app with: |
dotnet new maui -n NewApp
* Or create a [sample app](https://github.com/dotnet/maui-samples/tree/main/10.0/Apps/DeveloperBalance#developer-balance) with:
dotnet new maui -NewApp -sc
This sample includes:
* The [open-source Syncfusion Toolkit for .NET MAUI](https://www.syncfusion.com/net-maui-toolkit?utm_source=msftdotnet&utm_medium=banner&utm_campaign=mauipremium_sep25) with over 30 additional controls
* The [.NET MAUI Community Toolkit](https://github.com/CommunityToolkit/Maui) with many helpers and views
* [MVVM Toolkit](https://github.com/CommunityToolkit/dotnet)
BethMassi
previously approved these changes
Sep 23, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
rmarinho
approved these changes
Sep 24, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Added instructions for creating a new .NET MAUI app and using the Syncfusion Toolkit.