Skip to content

Commit e54be23

Browse files
nmetulevriverarazchohfi
authored
Updating guides with new init experience (#220)
Fixes: #227 --------- Co-authored-by: Rafael Rivera <rafael@withinwindows.com> Co-authored-by: Nikola Metulev <711864+nmetulev@users.noreply.github.com> Co-authored-by: Alexandre Zollinger Chohfi <alzollin@microsoft.com>
1 parent 9bb4327 commit e54be23

File tree

97 files changed

+1815
-1121
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+1815
-1121
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,14 @@ Checkout our getting started guides for step by step instructions of how to setu
6868
<img src="https://img.shields.io/badge/Electron-Get%20Started-47848F?style=for-the-badge&logo=electron&logoColor=white" alt="Get Started with Electron">
6969
</a>
7070
<br />
71+
<a href="./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+
<a href="./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 />
7179
<a href="./docs/guides/rust.md">
7280
<img src="https://img.shields.io/badge/Rust-Get%20Started-000000?style=for-the-badge&logo=rust&logoColor=white" alt="Get Started with Rust">
7381
</a>
@@ -86,7 +94,7 @@ Additional guides:
8694

8795
The easiest way to use the CLI is via WinGet (Windows Package Manager). In Terminal, simply run:
8896

89-
`winget install Microsoft.WinAppCli`
97+
`winget install Microsoft.winappcli --source winget`
9098

9199
### NPM <a href="https://www.npmjs.com/package/@microsoft/winappcli"> <img src="https://img.shields.io/npm/v/%40microsoft%2Fwinappcli?style=for-the-badge&logo=npm" alt="NPM" height="24"></a>
92100

docs/electron-get-started.md

Lines changed: 23 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,15 @@ By the end of this guide, you'll have an Electron app that:
1010
- ✅ Runs with app identity for testing protected APIs
1111
- ✅ Packages as a signed MSIX for distribution
1212

13+
## Prerequisites
14+
15+
Before starting, ensure you have:
16+
17+
- **Windows 11** (Copilot+ PC if using Phi Silica)
18+
- **Node.js** - `winget install OpenJS.NodeJS --source winget`
19+
- **.NET SDK v10** - `winget install Microsoft.DotNet.SDK.10 --source winget`
20+
- **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+
1322
## The Process
1423

1524
Building a Windows-enabled Electron app involves three main phases:
@@ -18,7 +27,7 @@ Building a Windows-enabled Electron app involves three main phases:
1827

1928
First, you'll set up your development environment with the necessary tools and SDKs. This includes:
2029
- Creating or configuring an Electron app
21-
- Installing WinAppCLI
30+
- Installing winapp CLI
2231
- Initializing Windows SDKs and required assets
2332
- Setting up your build pipeline
2433

@@ -30,15 +39,22 @@ First, you'll set up your development environment with the necessary tools and S
3039

3140
Next, you'll create a native addon that calls Windows APIs. Choose one of the following guides:
3241

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)
3450
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.
3551

3652
**Time:** ~20 minutes | **Difficulty:** Moderate | **Requirements:** Copilot+ PC
3753

3854
[Create a Phi Silica Addon →](guides/electron/phi-silica-addon.md)
3955

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.
4258

4359
**Time:** ~20 minutes | **Difficulty:** Moderate | **Requirements:** Windows 11
4460

@@ -56,27 +72,19 @@ Finally, you'll package your app as an MSIX for distribution. This includes:
5672

5773
[Package Your App →](guides/electron/packaging.md)
5874

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"`
67-
6875
## Quick Navigation
6976

7077
| Phase | Guide | What You'll Learn |
7178
|-------|-------|-------------------|
7279
| 1️⃣ | [Setup](guides/electron/setup.md) | Install tools, initialize SDKs, configure build pipeline |
80+
| 2️⃣ | [C++ Notification Addon](guides/electron/cpp-notification-addon.md) | Create C++ addon, call notification APIs, test with debug identity |
7381
| 2️⃣ | [Phi Silica Addon](guides/electron/phi-silica-addon.md) | Create C# addon, call AI APIs, test with debug identity |
74-
| 2️⃣ | [WinML Addon](guides/electron/winml-addon.md) | Create WinML addon, run ONNX models, integrate ML |
82+
| 2️⃣ | [WinML Addon](guides/electron/winml-addon.md) | Create C# addon, call WinML APIs, run ONNX models, integrate ML |
7583
| 3️⃣ | [Packaging](guides/electron/packaging.md) | Build production app, create MSIX, distribute |
7684

7785
## Additional Resources
7886

79-
- **[WinAppCLI Documentation](usage.md)** - Full CLI reference
87+
- **[winapp CLI Documentation](usage.md)** - Full CLI reference
8088
- **[Sample Electron App](../samples/electron/)** - Complete working example
8189
- **[AI Dev Gallery](https://aka.ms/aidevgallery)** - Sample gallery of all AI APIs
8290
- **[Windows App SDK Samples](https://github.com/microsoft/WindowsAppSDK-Samples)** - Collection of Windows App SDK samples

0 commit comments

Comments
 (0)