Skip to content

Commit 258cc74

Browse files
committed
Update ReadMe
1 parent 74fe71d commit 258cc74

File tree

4 files changed

+83
-116
lines changed

4 files changed

+83
-116
lines changed

README.md

Lines changed: 15 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -48,24 +48,15 @@ A detailed list can be found in the [ThirdPartyNotices.txt](ThirdPartyNotices.tx
4848

4949
---
5050

51-
# 🚀 DevWinUI 🚀
52-
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! 🎉
51+
# 🚀 DevWinUI 🚀 Your All-in-One Toolkit for Effortless WinUI 3 Development
52+
Whether you're an experienced developer or just starting your journey in app creation, DevWinUI provides everything you need to turn your ideas into reality. 🎉
5353

54-
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.
54+
DevWinUI equips you with a powerful suite of toolsincluding custom controls, classes, styles, and utilities — all purpose-built for WinUI 3, the cutting-edge UI framework for Windows 10, Windows 11, and beyond.
5555

56-
## Why Choose DevWinUI?
57-
### 🚀 Get Started Quickly:
58-
Kickstart your project in under a minute with built-in templates and scaffolding tools.
59-
### 🎨 Tailor Your App’s Look:
60-
Customize themes effortlessly — from classic light and dark modes to vibrant rainbow palettes.
61-
### 🧩 Elevate Your UI:
62-
Add flair with custom controls designed to enhance user experience.
63-
### ✨ Unlock Stunning Visuals:
64-
Use Win2D, a DirectX-based graphics library, to create mesmerizing effects like particle systems, gooey animations, watermarks, and more.
65-
### 🔧 Simplify Development:
66-
Streamline common tasks like navigation, theme management, and app updates with helper classes and extensions.
56+
Get your project up and running in under a minute using built-in templates and scaffolding tools. Simplify everyday development tasks like navigation, theme management, and app updates with ready-to-use helper classes and extensions.
6757

68-
DevWinUI is your gateway to creating visually stunning, user-friendly, and feature-rich apps on WinUI 3. Let's build something amazing together! 🚀
58+
With DevWinUI, you can build beautiful, intuitive, and high-performance WinUI 3 applications faster than ever.
59+
Let’s create something extraordinary together! 🚀
6960

7061
### 📚 Explore Our Documentation! 📚
7162
> [!TIP]
@@ -83,16 +74,6 @@ DevWinUI is your gateway to creating visually stunning, user-friendly, and featu
8374
<img src="https://get.microsoft.com/images/en-us%20dark.svg" width="200"/>
8475
</a>
8576

86-
![DevWinUI](https://raw.githubusercontent.com/Ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Docs/GalleryApp.png)
87-
88-
### ⚙️ Build & Contribute
89-
90-
To compile the project, contribute new features, or explore guidelines:
91-
92-
👉 Please refer to our [Contributing Guide](CONTRIBUTING.md) for detailed instructions.
93-
94-
### ⚠️ Gallery App Nightly Build
95-
9677
**nightly build** of the Gallery App generated automatically by GitHub Actions.
9778

9879
**This build may contain experimental features or untested changes.**
@@ -101,9 +82,14 @@ If you would like to test the nightly build:
10182
1. Visit the [GitHub Actions page](https://github.com/ghost1372/DevWinUI/actions).
10283
2. Download the zipped Gallery App from the latest successful workflow run. (`artifacts-[platform].zip`)
10384

104-
### 🧑‍💻 Contributing 🧑‍💻
105-
Found a bug? Want to contribute? We’d love your input!
106-
Happy coding! 🖥️💡
85+
86+
![DevWinUI](https://raw.githubusercontent.com/Ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Docs/GalleryApp.png)
87+
88+
### ⚙️ Build & Contribute
89+
90+
To compile the project, contribute new features, or explore guidelines:
91+
92+
👉 Please refer to our [Contributing Guide](CONTRIBUTING.md) for detailed instructions.
10793

10894
### Feedback and Issues
10995
If you encounter any issues or have feedback, please report them [here](https://github.com/ghost1372/DevWinUI/issues). Your input helps improve the app!
@@ -118,7 +104,6 @@ If you encounter any issues or have feedback, please report them [here](https://
118104
- ✨ AncestorBindingExtension
119105
- ✨ AnimationExtensions
120106
- ✨ CompositionAnimationController
121-
- ✨ FilePicker, SavePicker and FolderPicker which is working in Elevated, Packaged, UnPackaged and AOT apps.
122107
- ✨ ModernSystemMenu
123108
- ✨ RelativeDate
124109
- ✨ DragMoveAndResize
@@ -143,9 +128,6 @@ If you encounter any issues or have feedback, please report them [here](https://
143128
Install-Package DevWinUI
144129
```
145130

146-
> [!WARNING]
147-
> For more info See the [DevWinUI](dev/DevWinUI/README.md) and [Docs](https://Ghost1372.github.io/DevWinUI/)
148-
149131
---
150132

151133
## 🔥 DevWinUI.Controls 🔥
@@ -291,8 +273,6 @@ After installing, add the following resource to app.xaml
291273
<ResourceDictionary Source="ms-appx:///DevWinUI.Controls/Themes/Generic.xaml" />
292274
```
293275

294-
> [!WARNING]
295-
> For more info See the [DevWinUI.Controls](dev/DevWinUI.Controls/README.md) and [Docs](https://Ghost1372.github.io/DevWinUIControls/)
296276
---
297277
## 🔥 ContextMenu 🔥
298278
Add a new ContextMenu for Windows 11/10. You can use it in any .Net >= 8.0 apps which supports Package Identity. this means you can use it in WPF or WinForm with MSIX Packaging.
@@ -302,9 +282,6 @@ Add a new ContextMenu for Windows 11/10. You can use it in any .Net >= 8.0 apps
302282
Install-Package DevWinUI.ContextMenu
303283
```
304284

305-
> [!WARNING]
306-
> For more info See the [DevWinUI.ContextMenu](dev/DevWinUI.ContextMenu/README.md) and [Docs](https://Ghost1372.github.io/DevWinUIContextMenu/)
307-
308285
---
309286

310287
## 🥷 Project Templates 🥷
@@ -313,9 +290,7 @@ Install-Package DevWinUI.ContextMenu
313290
> 🔥 Create a new project easily with your custom options, you can use our project templates and wizard!
314291
> Download and install our VSIX extension from [Marketplace](https://marketplace.visualstudio.com/items?itemName=MahdiHosseini.DevWinUITemplates)
315292
316-
![DevWinUI](https://raw.githubusercontent.com/Ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Templates/Demo.png)
317-
318-
![DevWinUITemplates](https://raw.githubusercontent.com/Ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Templates/1.png)
293+
![DevWinUITemplates](https://raw.githubusercontent.com/ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Templates/TemplateDemo.jpg)
319294

320295
---
321296

@@ -533,9 +508,6 @@ Install-Package DevWinUI.ContextMenu
533508

534509
![DevWinUI](https://raw.githubusercontent.com/Ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Docs/ScrollButtonStyle.png)
535510

536-
### Picker (Elevated/AOT/Packaged/UnPackaged Support)
537-
![DevWinUI](https://raw.githubusercontent.com/Ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Docs/Picker.png)
538-
539511
### DragMoveAndResize
540512
![DevWinUI](https://raw.githubusercontent.com/ghost1372/DevWinUI-Resources/refs/heads/main/DevWinUI-Docs/DragMoveAndResize.gif)
541513

dev/DevWinUI.ContextMenu/README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,25 @@
1-
<p align="center">
2-
<a href="https://www.nuget.org/profiles/DevWinUI">
3-
<img alt="DevWinUI Nugets" src="https://img.shields.io/badge/DevWinUI-Nugets-green"></img>
4-
</a>
5-
<a href="https://www.nuget.org/packages/DevWinUI.ContextMenu">
6-
<img alt="nuget-version" src="https://img.shields.io/nuget/v/DevWinUI.ContextMenu.svg"></img>
7-
</a>
8-
<a href="https://www.nuget.org/packages/DevWinUI.ContextMenu">
9-
<img alt="Installed" src="https://img.shields.io/nuget/dt/DevWinUI.ContextMenu?color=brightgreen&label=Installs"></img>
10-
</a>
11-
<a href="https://ghost1372.github.io/devWinUI/">
12-
<img alt="Docs" src="https://img.shields.io/badge/Document-Here-critical"></img>
13-
</a>
14-
</p>
15-
16-
<br>
17-
<p align="center">
18-
<b>🙌 Donate Bitcoin with <a href="https://link.trustwallet.com/send?coin=0&address=bc1qzs4kt4aeqym6gsde669g5rksv4swjhzjqqp23a">Trust</a>🙌</b><br>
19-
<b>🙌 Donate ETH with <a href="https://link.trustwallet.com/send?coin=60&address=0x40Db4476c1D498b167f76A2c7ED9D45b65eb5d0C">Trust</a>🙌</b><br><br>
20-
<b>🙌 Bitcoin: bc1qzs4kt4aeqym6gsde669g5rksv4swjhzjqqp23a<br></b>
21-
<b>🙌 ETH: 0x40Db4476c1D498b167f76A2c7ED9D45b65eb5d0C</b>
22-
</p>
23-
<br>
1+
<h3 align="center">
2+
<a href="https://ghost1372.github.io">Documentation</a>
3+
<span> · </span>
4+
<a href="https://ghost1372.github.io/ReleaseNotes">Release notes</a>
5+
<span> · </span>
6+
<a href="https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Gallery">Samples</a>
7+
<span> · </span>
8+
<a href="https://apps.microsoft.com/detail/DevWinUI%20Gallery%20App/9nmx5x5dlsrq?launch=true
9+
&mode=mini">Gallery App (Store)</a>
10+
</h3>
11+
12+
<center>
13+
14+
<div align="center">
15+
16+
|Packages|Download/Installation|Documentation|
17+
|:---|:---|:---:|
18+
|[![NuGet Version](https://img.shields.io/nuget/v/DevWinUI.ContextMenu?label=DevWinUI.ContextMenu)](https://www.nuget.org/packages/DevWinUI.ContextMenu)|[![NuGet Download](https://img.shields.io/nuget/dt/DevWinUI.ContextMenu?label=DevWinUI.ContextMenu)](https://www.nuget.org/packages/DevWinUI.ContextMenu)|[![Document](https://img.shields.io/badge/See%20Here-%20?logo=github&label=Document&color=red)](https://Ghost1372.github.io/DevWinUIContextMenu)|
19+
20+
</div>
21+
22+
---
2423

2524
# ContextMenu
2625
Add a new ContextMenu for Windows 11/10. You can use it in any .Net >= 8.0 apps which supports Package Identity. this means you can use it in WPF or WinForm with MSIX Packaging.
@@ -33,4 +32,4 @@ read the docs to see how to use it
3332

3433
## Documentation
3534

36-
See Here for Online [Documentation](https://ghost1372.github.io/devWinUI/)
35+
See Here for Online [Documentation](https://ghost1372.github.io/DevWinUIContextMenu/)

dev/DevWinUI.Controls/README.md

Lines changed: 23 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
1-
<p align="center">
2-
<img alt="IDE-version" src="https://img.shields.io/badge/IDE-vs2022-red"/>
3-
<a href="https://www.nuget.org/profiles/DevWinUI">
4-
<img alt="DevWinUI Nugets" src="https://img.shields.io/badge/DevWinUI-Nugets-green"></img>
5-
</a>
6-
<a href="https://www.nuget.org/packages/DevWinUI.Controls">
7-
<img alt="nuget-version" src="https://img.shields.io/nuget/v/DevWinUI.Controls.svg"></img>
8-
</a>
9-
<a href="https://www.nuget.org/packages/DevWinUI.Controls">
10-
<img alt="Installed" src="https://img.shields.io/nuget/dt/DevWinUI.Controls?color=brightgreen&label=Installs"></img>
11-
</a>
12-
<a href="https://ghost1372.github.io/devWinUI/">
13-
<img alt="Docs" src="https://img.shields.io/badge/Document-Here-critical"></img>
14-
</a>
15-
</p>
16-
17-
<br>
18-
<p align="center">
19-
<b>🙌 Donate Bitcoin with <a href="https://link.trustwallet.com/send?coin=0&address=bc1qzs4kt4aeqym6gsde669g5rksv4swjhzjqqp23a">Trust</a>🙌</b><br>
20-
<b>🙌 Donate ETH with <a href="https://link.trustwallet.com/send?coin=60&address=0x40Db4476c1D498b167f76A2c7ED9D45b65eb5d0C">Trust</a>🙌</b><br><br>
21-
<b>🙌 Bitcoin: bc1qzs4kt4aeqym6gsde669g5rksv4swjhzjqqp23a<br></b>
22-
<b>🙌 ETH: 0x40Db4476c1D498b167f76A2c7ED9D45b65eb5d0C</b>
23-
</p>
24-
<br>
1+
<h3 align="center">
2+
<a href="https://ghost1372.github.io">Documentation</a>
3+
<span> · </span>
4+
<a href="https://ghost1372.github.io/ReleaseNotes">Release notes</a>
5+
<span> · </span>
6+
<a href="https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Gallery">Samples</a>
7+
<span> · </span>
8+
<a href="https://apps.microsoft.com/detail/DevWinUI%20Gallery%20App/9nmx5x5dlsrq?launch=true
9+
&mode=mini">Gallery App (Store)</a>
10+
</h3>
11+
12+
<center>
13+
14+
<div align="center">
15+
16+
|Packages|Download/Installation|Documentation|
17+
|:---|:---|:---:|
18+
|[![NuGet Version](https://img.shields.io/nuget/v/DevWinUI.Controls?label=DevWinUI.Controls)](https://www.nuget.org/packages/DevWinUI.Controls)|[![NuGet Download](https://img.shields.io/nuget/dt/DevWinUI.Controls?label=DevWinUI.Controls)](https://www.nuget.org/packages/DevWinUI.Controls)|[![Document](https://img.shields.io/badge/See%20Here-%20?logo=github&label=Document&color=red)](https://Ghost1372.github.io/DevWinUIControls/)|
19+
20+
</div>
21+
22+
---
2523

2624
# DevWinUI.Controls
2725

@@ -45,6 +43,6 @@ See the [Gallery](https://github.com/Ghost1372/DevWinUI) app to see how to use i
4543

4644
## Documentation
4745

48-
See Here for Online [Documentation](https://ghost1372.github.io/devWinUI/)
46+
See Here for Online [Documentation](https://ghost1372.github.io/DevWinUIControls/)
4947

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

dev/DevWinUI/README.md

Lines changed: 22 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,25 @@
1-
<p align="center">
2-
<img alt="IDE-version" src="https://img.shields.io/badge/IDE-vs2022-red"/>
3-
<a href="https://www.nuget.org/profiles/DevWinUI">
4-
<img alt="DevWinUI Nugets" src="https://img.shields.io/badge/DevWinUI-Nugets-green"></img>
5-
</a>
6-
<a href="https://www.nuget.org/packages/DevWinUI">
7-
<img alt="nuget-version" src="https://img.shields.io/nuget/v/DevWinUI.svg"></img>
8-
</a>
9-
<a href="https://www.nuget.org/packages/DevWinUI">
10-
<img alt="Installed" src="https://img.shields.io/nuget/dt/DevWinUI?color=brightgreen&label=Installs"></img>
11-
</a>
12-
<a href="https://ghost1372.github.io/devWinUI/">
13-
<img alt="Docs" src="https://img.shields.io/badge/Document-Here-critical"></img>
14-
</a>
15-
</p>
16-
17-
<br>
18-
<p align="center">
19-
<b>🙌 Donate Bitcoin with <a href="https://link.trustwallet.com/send?coin=0&address=bc1qzs4kt4aeqym6gsde669g5rksv4swjhzjqqp23a">Trust</a>🙌</b><br>
20-
<b>🙌 Donate ETH with <a href="https://link.trustwallet.com/send?coin=60&address=0x40Db4476c1D498b167f76A2c7ED9D45b65eb5d0C">Trust</a>🙌</b><br><br>
21-
<b>🙌 Bitcoin: bc1qzs4kt4aeqym6gsde669g5rksv4swjhzjqqp23a<br></b>
22-
<b>🙌 ETH: 0x40Db4476c1D498b167f76A2c7ED9D45b65eb5d0C</b>
23-
</p>
24-
<br>
1+
<h3 align="center">
2+
<a href="https://ghost1372.github.io">Documentation</a>
3+
<span> · </span>
4+
<a href="https://ghost1372.github.io/ReleaseNotes">Release notes</a>
5+
<span> · </span>
6+
<a href="https://github.com/ghost1372/DevWinUI/tree/main/dev/DevWinUI.Gallery">Samples</a>
7+
<span> · </span>
8+
<a href="https://apps.microsoft.com/detail/DevWinUI%20Gallery%20App/9nmx5x5dlsrq?launch=true
9+
&mode=mini">Gallery App (Store)</a>
10+
</h3>
11+
12+
<center>
13+
14+
<div align="center">
15+
16+
|Packages|Download/Installation|Documentation|
17+
|:---|:---|:---:|
18+
|[![NuGet Version](https://img.shields.io/nuget/v/DevWinUI?label=DevWinUI)](https://www.nuget.org/packages/DevWinUI)|[![NuGet Download](https://img.shields.io/nuget/dt/DevWinUI?label=DevWinUI)](https://www.nuget.org/packages/DevWinUI)|[![Document](https://img.shields.io/badge/See%20Here-%20?logo=github&label=Document&color=red)](https://Ghost1372.github.io/DevWinUI)|
19+
20+
</div>
21+
22+
---
2523

2624
# DevWinUI
2725

0 commit comments

Comments
 (0)