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
+15-21Lines changed: 15 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,6 +39,12 @@ Perfect for:
39
39
-**Developers testing and deploying** adding app identity for development or packaging for deployment
40
40
-**CI/CD pipelines** automating Windows app builds
41
41
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
+
42
48
## 📦 Installation
43
49
44
50
### WinGet
@@ -60,23 +66,9 @@ You can install the CLI for Electron projects via NPM:
60
66
61
67
### Download Release Manually
62
68
63
-
Or, download the latest build from GitHub Releases:
|**`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
-
80
72
## 📋 Usage
81
73
82
74
Once installed (see [Installation](#-installation) above), verify the installation by calling the CLI:
@@ -123,6 +115,14 @@ npx winapp --help
123
115
124
116
The full CLI usage can be found here: [Documentation](/docs/usage.md)
125
117
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
+
126
126
## 🔧 Feedback
127
127
128
128
-[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
134
134
135
135
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).
136
136
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
-
143
137
## Support
144
138
145
139
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