Skip to content

Commit 658711e

Browse files
committed
Update README.md
1 parent da1570e commit 658711e

1 file changed

Lines changed: 58 additions & 23 deletions

File tree

README.md

Lines changed: 58 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
<p align="center">
1+
# 🌟 Welcome to DevWinUI! 🌟
2+
<p align="center">
23
<img alt="IDE-version" src="https://img.shields.io/badge/2022-Version?logo=visual%20studio&label=Visual%20Studio&color=blue"/>
34
<a href="https://www.nuget.org/profiles/DevWinUI">
45
<img alt="Packages" src="https://img.shields.io/badge/Packages-%20?logo=nuget&label=Nuget&color=blue"/>
@@ -34,15 +35,23 @@
3435
---
3536

3637
# 🚀 DevWinUI 🚀
37-
Welcome to DevWinUI! your go-to toolkit for building WinUI 3 applications with ease. Whether youre a seasoned developer or just starting out, we’ve got you covered! 🎉
38+
Your ultimate toolkit for building WinUI 3 applications effortlessly. Whether you're a seasoned developer or taking your first steps into app development, DevWinUI has everything you need to bring your ideas to life! 🎉
3839

39-
DevWinUI is a collection of useful classes, controls, styles, and codes for WinUI 3, the modern native UI platform for Windows 10+. With DevWinUI, you can:
40+
DevWinUI empowers you with a robust collection of tools, including custom classes, controls, styles, and utilities tailored for WinUI 3, the modern UI framework for Windows 10 and beyond.
4041

41-
- ✨ Create a WinUI 3 app in less than a minute with the built-in project templates and scaffolding tools.
42-
- ✨ Customize the appearance of your app with various themes, such as rainbow, dark, light, and more.
43-
- ✨ Enhance your UI with custom controls.
44-
- ✨ Leverage the power of Win2D, a DirectX-based graphics library for WinUI, to create stunning effects, such as particle, gooey, watermark, etc.
45-
- ✨ Simplify common tasks, such as navigation, theme, update, etc. with the helper classes and extensions.
42+
## Why Choose DevWinUI?
43+
### 🚀 Get Started Quickly:
44+
Kickstart your project in under a minute with built-in templates and scaffolding tools.
45+
### 🎨 Tailor Your App’s Look:
46+
Customize themes effortlessly — from classic light and dark modes to vibrant rainbow palettes.
47+
### 🧩 Elevate Your UI:
48+
Add flair with custom controls designed to enhance user experience.
49+
### ✨ Unlock Stunning Visuals:
50+
Use Win2D, a DirectX-based graphics library, to create mesmerizing effects like particle systems, gooey animations, watermarks, and more.
51+
### 🔧 Simplify Development:
52+
Streamline common tasks like navigation, theme management, and app updates with helper classes and extensions.
53+
54+
DevWinUI is your gateway to creating visually stunning, user-friendly, and feature-rich apps on WinUI 3. Let's build something amazing together! 🚀
4655

4756
### 📚 Explore Our Documentation! 📚
4857
> [!TIP]
@@ -62,30 +71,59 @@ DevWinUI is a collection of useful classes, controls, styles, and codes for WinU
6271

6372
![DevWinUI](https://raw.githubusercontent.com/Ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Docs/GalleryApp.png)
6473

74+
### ⚙️ Compile Source Code
75+
76+
> [!TIP]
77+
> Please confirm that your development environment meets the requirements before compiling.
78+
79+
#### 1. 🖥️ Visual Studio 2022
80+
Ensure that your installation includes the appropriate workloads:
81+
- On the `Workloads` tab of the Visual Studio installation dialog box, select:
82+
- **.NET Desktop Development**
83+
- **Windows Application Development**
84+
- Ensure the **Windows 11 SDK (10.0.19041.0)** is installed.
85+
86+
#### 2. 🛠️ .NET SDKs
87+
- Ensure .NET versions `8.x` and `9.x` are installed.
88+
89+
#### 3. 📂 Solution Format
90+
- This project uses the **SLNX format** for solutions, a new format introduced in Visual Studio Preview 17.11.
91+
- ⚠️ **Note:** You currently need the latest Visual Studio 2022 Preview version.
92+
93+
Make sure your environment matches these requirements to avoid any issues during compilation.
94+
95+
96+
### ⚠️ Nightly Build
97+
98+
**nightly build** of the Gallery App generated automatically by GitHub Actions.
99+
100+
#### Important Notes:
101+
- This build may contain experimental features or untested changes.
102+
- Stability and performance are not guaranteed.
103+
- The app is provided as-is and should be used **only for testing purposes**.
104+
- For production use, please download the latest **stable release**.
105+
106+
### Want the Nightly Build?
107+
If you would like to test the nightly build:
108+
1. Visit the [GitHub Actions page](https://github.com/ghost1372/DevWinUI/actions).
109+
2. Download the zipped Gallery App from the latest successful workflow run. (`artifacts-[platform].zip`)
110+
65111
### 🧑‍💻 Contributing 🧑‍💻
66112
Found a bug? Want to contribute? We’d love your input!
67113
Happy coding! 🖥️💡
68114

69-
### Compile source code
70-
71-
> [!TIP]
72-
> Please confirm that your development environment meets the requirements before compiling.
73-
- Visual Studio 2022 On the `Workloads` tab of the installation dialog box, select as appropriate:
74-
- select .NET Desktop Development
75-
- select Windows application development
76-
- make sure `Windows 11 SDK (10.0.19041.0)`.
77-
- .Net `8.x` and `9.x`
115+
### Feedback and Issues
116+
If you encounter any issues or have feedback, please report them [here](https://github.com/ghost1372/DevWinUI/issues). Your input helps improve the app!
78117

79118
---
80119

81120
## 🔥 DevWinUI 🔥
82-
Experience WinUI 3 quickly and easily with the help of Core, Everything you need to develop an application is gathered in one place. Helpers, Extensions...
83-
84121
### ⚡ What’s Inside? ⚡
85122
- ✨ Converter
86123
- ✨ Extensions
87124
- ✨ Helpers
88125
- ✨ NavigationService
126+
- ✨ JsonNavigationService
89127
- ✨ RainbowFrame
90128
- ✨ ThemeService
91129
- ✨ PickCredential
@@ -104,9 +142,6 @@ Install-Package DevWinUI
104142
---
105143

106144
## 🔥 DevWinUI.Controls 🔥
107-
Experience WinUI 3 quickly and easily with the help of DevWinUI.Controls, Everything you need to develop an application is gathered in one place.
108-
DevWinUI.Controls Includes custom controls and styles.
109-
110145
### ⚡ What’s Inside? ⚡
111146
- ✨ BreadcrumbNavigator
112147
- ✨ PinBox
@@ -191,7 +226,7 @@ Install-Package DevWinUI.ContextMenu
191226
192227
---
193228

194-
## 🥷 [Project Templates](https://github.com/Ghost1372/DevWinUI) 🥷
229+
## 🥷 Project Templates 🥷
195230

196231
> [!TIP]
197232
> 🔥 Create a new project easily with your custom options, you can use our project templates and wizard!

0 commit comments

Comments
 (0)