[wip] feat: linux and windows cfg options (#729)

Co-authored-by: The Jared Wilcurt <[email protected]>
nwutils · Dec 25, 2022 · 92c4aba · 92c4aba
1 parent 3362547
commit 92c4aba
Show file tree

Hide file tree

Showing 16 changed files with 219 additions and 34,525 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -23,14 +23,14 @@ nwbuild({
   srcDir: "./nwapp",
   mode: "run",
   version: "0.70.1",
-  flavour: "sdk",
+  flavor: "sdk",
 });
 ```
 
 CLI usage
 
 ```shell
-nwbuild ./nwapp --mode=run --version=0.70.1 --flavour=sdk
+nwbuild ./nwapp --mode=run --version=0.70.1 --flavor=sdk
 ```
 
 package.json usage
@@ -45,7 +45,7 @@ package.json usage
     "srcDir": "./nwapp",
     "mode": "run",
     "version": "0.70.1",
-    "flavour": "sdk"
+    "flavor": "sdk"
   }
 }
 ```
@@ -61,7 +61,7 @@ nwbuild({
   srcDir: "./nwapp",
   mode: "build",
   version: "0.70.1",
-  flavour: "normal",
+  flavor: "normal",
   platform: "linux",
   arch: "x64",
   outDir: "./out",
@@ -71,7 +71,7 @@ nwbuild({
 CLI usage
 
 ```shell
-nwbuild ./nwapp --mode=build --version=0.70.1 --flavour=normal --platform=linux --arch=x64 --outDir=./out
+nwbuild ./nwapp --mode=build --version=0.70.1 --flavor=normal --platform=linux --arch=x64 --outDir=./out
 ```
 
 package.json usage
@@ -86,7 +86,7 @@ package.json usage
     "srcDir": "./nwapp",
     "mode": "build",
     "version": "0.70.1",
-    "flavour": "normal",
+    "flavor": "normal",
     "platform": "linux",
     "arch": "x64",
     "outDir": "./out"
@@ -102,13 +102,13 @@ package.json usage
 
 | Name        | Type                                | Default                    | Description                                                                    |
 | ----------- | ----------------------------------- | -------------------------- | ------------------------------------------------------------------------------ |
-| srcDir      | `string`                            |                            | Directory to hold NW app files                                                 |
-| mode        | `run \| build`                      |                            | Run or build application                                                       |
-| version     | `latest \| stable \| string \| lts` |                            | NW runtime version                                                             |
-| flavour     | `sdk \| normal`                     |                            | NW runtime build flavour.                                                      |
-| platform    | `linux \| osx \| win`               |                            | NW supported platforms                                                         |
-| arch        | `ia32 \| x64`                       |                            | NW supported architectures                                                     |
-| outDir      | `string`                            |                            | Directory to store build artifacts                                             |
+| srcDir      | `string`                            | `./`                       | Directory to hold NW app files                                                 |
+| mode        | `run \| build`                      | `build`                    | Run or build application                                                       |
+| version     | `latest \| stable \| string \| lts` | `latest`                   | NW runtime version                                                             |
+| flavor      | `sdk \| normal`                     | `normal`                   | NW runtime build flavor.                                                       |
+| platform    | `linux \| osx \| win`               | `<current platform>`       | NW supported platforms                                                         |
+| arch        | `ia32 \| x64`                       | `<current architecture>`   | NW supported architectures                                                     |
+| outDir      | `string`                            | `./out`                    | Directory to store build artifacts                                             |
 | cacheDir    | `string`                            | `./cacheDir`               | Directory to store NW binaries                                                 |
 | downloadUrl | `string`                            | `https://dl.nwjs.io`       | URI to download NW binaries from                                               |
 | manifestUrl | `string`                            | `https://nwjs.io/versions` | URI to download manifest from                                                  |