Quellcode durchsuchen

docs(project): update Options and FAQs

evshiron vor 8 Jahren
Ursprung
Commit
b52ef2c2a6
2 geänderte Dateien mit 7 neuen und 1 gelöschten Zeilen
  1. 6 0
      docs/FAQs.md
  2. 1 1
      docs/Options.md

+ 6 - 0
docs/FAQs.md

@@ -19,3 +19,9 @@ Please follow [evshiron/nwjs-builder-phoenix#7](https://github.com/evshiron/nwjs
 Simply add `--chrome-app` to the commandline arguments which enables support for Chrome Apps.
 
 Also configurations should be set in `manifest.json` instead of `package.json` but within the same `build` property.
+
+> What's `nsis` target and what's the difference with `nsis` and `nsis7z` target?
+
+`nsis` target will build NSIS installers (and updaters when `package.json:build.nsis.diffUpdaters` is `true`) for Windows.
+
+`nsis7z` target will use `7za` to compress and [Nsis7z plug-in](http://nsis.sourceforge.net/Nsis7z_plug-in) to extract, instead of the built-in LZMA compression, resulting in a better and faster compression. But it doesn't list installed files, onlya percentage indicating the progress of extraction when installing.

+ 1 - 1
docs/Options.md

@@ -11,7 +11,7 @@ nwVersion | string | Used NW.js version. Support `lts`, `stable` and `latest` sy
 nwFlavor | string | Used NW.js flavor for builder. Runner will always use `sdk`. `normal` or `sdk`. Defaults to `normal`.
 output | string | Output directory relative to the project root. Defaults to `./dist/`.
 packed | boolean | Whether to pack app or not. Packed app needed to be extracted at launch time. Defaults to `false`.
-targets | string[] | Target formats to build. `zip`, `7z`, etc. Defaults to `[]`.
+targets | string[] | Target formats to build. `zip`, `7z`, `nsis` and `nsis7z`, etc. Defaults to `[]`.
 files | string[] | Glob patterns for included files. Exclude `${ output }` automatically. Defaults to `[ '**/*' ]`.
 excludes | string[] | Glob patterns for excluded files. Defaults to `[]`.
 appId | string | App identity URI. Defaults to `io.github.nwjs.${ name }`.