You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-1Lines changed: 9 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,6 +68,14 @@ Checkout our getting started guides for step by step instructions of how to setu
68
68
<img src="https://img.shields.io/badge/Electron-Get%20Started-47848F?style=for-the-badge&logo=electron&logoColor=white" alt="Get Started with Electron">
69
69
</a>
70
70
<br />
71
+
<ahref="./docs/guides/dotnet.md">
72
+
<img src="https://img.shields.io/badge/.NET/WPF/WinForms-Get%20Started-512BD4?style=for-the-badge&logo=dotnet&logoColor=white" alt="Get Started with .NET">
73
+
</a>
74
+
<br />
75
+
<ahref="./docs/guides/cpp.md">
76
+
<img src="https://img.shields.io/badge/C++-Get%20Started-00599C?style=for-the-badge&logo=cplusplus&logoColor=white" alt="Get Started with C++">
77
+
</a>
78
+
<br />
71
79
<ahref="./docs/guides/rust.md">
72
80
<img src="https://img.shields.io/badge/Rust-Get%20Started-000000?style=for-the-badge&logo=rust&logoColor=white" alt="Get Started with Rust">
73
81
</a>
@@ -86,7 +94,7 @@ Additional guides:
86
94
87
95
The easiest way to use the CLI is via WinGet (Windows Package Manager). In Terminal, simply run:
-**Visual Studio with the Native Desktop Workload** - `winget install --id Microsoft.VisualStudio.Community --source winget --override "--add Microsoft.VisualStudio.Workload.NativeDesktop --includeRecommended --passive --wait"`
21
+
13
22
## The Process
14
23
15
24
Building a Windows-enabled Electron app involves three main phases:
@@ -18,7 +27,7 @@ Building a Windows-enabled Electron app involves three main phases:
18
27
19
28
First, you'll set up your development environment with the necessary tools and SDKs. This includes:
20
29
- Creating or configuring an Electron app
21
-
- Installing WinAppCLI
30
+
- Installing winapp CLI
22
31
- Initializing Windows SDKs and required assets
23
32
- Setting up your build pipeline
24
33
@@ -30,15 +39,22 @@ First, you'll set up your development environment with the necessary tools and S
30
39
31
40
Next, you'll create a native addon that calls Windows APIs. Choose one of the following guides:
32
41
33
-
#### Option A: [Creating a Phi Silica Addon](guides/electron/phi-silica-addon.md)
42
+
#### Option A: [Creating a C++ Notification Addon](guides/electron/cpp-notification-addon.md)
43
+
Learn how to create a C++ addon that calls the Windows App SDK notification APIs. This is a great starting point for understanding native addons before diving into more complex scenarios.
44
+
45
+
**Time:**~15 minutes | **Difficulty:** Easy | **Requirements:** Windows 11
46
+
47
+
[Create a C++ Notification Addon →](guides/electron/cpp-notification-addon.md)
48
+
49
+
#### Option B: [Creating a Phi Silica Addon](guides/electron/phi-silica-addon.md)
34
50
Learn how to create a C# addon that uses the Phi Silica AI model to summarize text on-device. Phi Silica is a small language model that runs locally on Windows 11 devices with NPUs.
35
51
36
52
**Time:**~20 minutes | **Difficulty:** Moderate | **Requirements:** Copilot+ PC
37
53
38
54
[Create a Phi Silica Addon →](guides/electron/phi-silica-addon.md)
39
55
40
-
#### Option B: [Creating a WinML Addon](guides/electron/winml-addon.md)
41
-
Learn how to create an addon that uses Windows Machine Learning (WinML) to run custom ONNX models for image classification, object detection, and more.
56
+
#### Option C: [Creating a WinML Addon](guides/electron/winml-addon.md)
57
+
Learn how to create a C# addon that uses Windows Machine Learning (WinML) to run custom ONNX models for image classification, object detection, and more.
42
58
43
59
**Time:**~20 minutes | **Difficulty:** Moderate | **Requirements:** Windows 11
44
60
@@ -56,27 +72,19 @@ Finally, you'll package your app as an MSIX for distribution. This includes:
56
72
57
73
[Package Your App →](guides/electron/packaging.md)
58
74
59
-
## Prerequisites
60
-
61
-
Before starting, ensure you have:
62
-
63
-
-**Windows 11** (Copilot+ PC if using Phi Silica)
64
-
-**Node.js** - `winget install OpenJS.NodeJS`
65
-
-**.NET SDK v10** - `Microsoft.DotNet.SDK.10`
66
-
-**Visual Studio with the Native Desktop Workload** - `winget install --id Microsoft.VisualStudio.Community --source winget --override "--add Microsoft.VisualStudio.Workload.NativeDesktop --includeRecommended --passive --wait"`
0 commit comments