Skip to content

Commit 03b98fe

Browse files
authored
docs: clarify local README tests (#20)
1 parent 3901b21 commit 03b98fe

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Electron-Windows-MSIX is a module that lets you create an MSIX installer from a
1313
### Installation
1414

1515
```
16-
npm install electron-windows-msix
16+
npm install electron-windows-msix --save-dev
1717
```
1818

1919
## Usage
@@ -53,7 +53,7 @@ packageMinOSVersion - The minimum OS version the MSIX package requires. Th
5353
packageMaxOSVersionTested - The maximum OS version the MSIX package has been tested on. This will be used to set the MaxVersionTested attribute in the TargetDeviceFamily element in the AppxManifest.xml.
5454
```
5555

56-
#### Minimal example that creates a manifest and a dev cert
56+
### Minimal example that creates a manifest and a dev cert
5757
```ts
5858
import { packageMSIX } from "electron-windows-msix";
5959

@@ -70,7 +70,7 @@ await packageMSIX({
7070
});
7171
```
7272

73-
#### Minimal example that derives all possible data from the Manifest
73+
### Minimal example that derives all possible data from the Manifest
7474
```ts
7575
import { packageMSIX } from "electron-windows-msix";
7676

@@ -86,7 +86,7 @@ await packageMSIX({
8686
});
8787
```
8888

89-
#### Example that controls all options with via manifest varaibles
89+
### Example that controls all options with via manifest varaibles
9090
```js
9191
import { packageMSIX } from "electron-windows-msix";
9292

@@ -120,7 +120,7 @@ await packageMSIX({
120120
});
121121
```
122122

123-
#### Example that controls all options with an existing manifest
123+
### Example that controls all options with an existing manifest
124124
```ts
125125
import { packageMSIX } from "electron-windows-msix";
126126

@@ -141,6 +141,12 @@ await packageMSIX({
141141
});
142142
```
143143

144+
## Local Development
145+
146+
* Running the local E2E tests requires:
147+
* [PowerShell 7](https://learn.microsoft.com/en-us/powershell/?view=powershell-7.5)
148+
* [Windows 11 SDK 10.0.26100.0](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/)
149+
144150
----
145151
#### [MIT License (MIT)](LICENSE) | Copyright (c) Jan Hannemann.
146152
----

0 commit comments

Comments
 (0)