Skip to content

Commit 9083424

Browse files
authored
Added winml sample and guide (#199)
1 parent aac2ce4 commit 9083424

Some content is hidden

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

44 files changed

+11671
-831
lines changed

README.md

Lines changed: 15 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,12 @@ Perfect for:
3939
- **Developers testing and deploying** adding app identity for development or packaging for deployment
4040
- **CI/CD pipelines** automating Windows app builds
4141

42+
## ✏️ Get started
43+
44+
Checkout our getting started guides for step by step instructions:
45+
- [Electron guide](/docs/electron-get-started.md): step by step guide of using Windows App SDK APIs in a new Electron application with a C# addon, debugging with identity, and MSIX packaging.
46+
- [Packaging an EXE/CLI](/docs/guides/packaging-cli.md): step by step guide of packaging an existing exe/cli as MSIX
47+
4248
## 📦 Installation
4349

4450
### WinGet
@@ -60,23 +66,9 @@ You can install the CLI for Electron projects via NPM:
6066

6167
### Download Release Manually
6268

63-
Or, download the latest build from GitHub Releases:
64-
69+
Download the latest build from GitHub Releases:
6570
**[👉 Download Latest Build](https://github.com/microsoft/WinAppCli/releases/latest)**
6671

67-
**Available Options:**
68-
69-
| Package | Description | Use Case |
70-
|---------|-------------|----------|
71-
| **`winappcli_[version]_[platform].msix`** | 📦 MSIX Installer | Easy to install, automatically added to path, great for general usage |
72-
| **`winappcli-[version]-[platform].zip`** | 📦 Standalone Binaries | Portable, no install needed - great for CI/CD |
73-
| **`microsoft-winappcli-[version].tgz`** | 📚 NPM Package | For Node.js/Electron projects |
74-
75-
## Get started
76-
77-
Checkout our getting started guides for step by step instructions:
78-
- [Electron guide](/docs/electron-get-started.md): step by step guide of using the Phi Silica APIs in a new Electron application with a C# addon, debugging with identity, and MSIX packaging.
79-
8072
## 📋 Usage
8173

8274
Once installed (see [Installation](#-installation) above), verify the installation by calling the CLI:
@@ -123,6 +115,14 @@ npx winapp --help
123115

124116
The full CLI usage can be found here: [Documentation](/docs/usage.md)
125117

118+
119+
## 🧾 Samples
120+
121+
This repository will continue to be added with samples. Currently the following samples exist:
122+
123+
- [Electron sample](/samples/electron/README.md): a default Electron Forge generated application + initialized a winapp project with appxmanifest, assets + native addon + C# addon + generates cert
124+
- [Electron WinML sample](/samples/electron-winml/README.md): a simple Electron application using Windows ML for classifying images
125+
126126
## 🔧 Feedback
127127

128128
- [File an issue, feature request or bug](https://github.com/microsoft/WinAppCli/issues): please ensure that you are not filing a duplicate issue
@@ -134,12 +134,6 @@ We are actively working on improving Node and Python support. These features are
134134

135135
This repository also contains an **experimental** app (GUI) that wraps the CLI and provides an intuitive, drag-and-drop experience. [See the docs](/docs/gui-usage.md) for more details. [Download the app here](https://github.com/microsoft/WinAppCli/releases/tag/v0.1.1-gui).
136136

137-
## 🧾 Samples
138-
139-
This repository will continue to be added with samples. Currently the following samples exist:
140-
141-
- [Electron sample](/samples/electron/README.md): a default Electron Forge generated application + initialized a winapp project with appxmanifest, assets + native addon + C# addon + generates cert
142-
143137
## Support
144138

145139
Need help or have questions about the Windows App Development CLI? Visit our **[Support Guide](./SUPPORT.md)** for information about our issue templates and triage process.

0 commit comments

Comments
 (0)