Browse Source

chore(tests): set icons in sample project

evshiron 8 years ago
parent
commit
ea5350f6d9

+ 1 - 1
README.md

@@ -73,7 +73,7 @@ The above code snippet enables `npm run dist` and `npm run start`/`npm start`. T
 
 This should be the common use case, read the following Options section and [FAQs](./docs/FAQs.md) if something is missing.
 
-See also [project for testing](./assets/project/) and [test cases](./test/) for reference.
+See also [sample project](./assets/project/) and [test cases](./test/) for reference.
 
 ## Options
 

+ 2 - 0
assets/project/README.md

@@ -0,0 +1,2 @@
+
+Icons from [EasyIcon](https://www.easyicon.net/language.en/567185-Public_Domain_icon.html), licensed with Creative Commons Attribution 3.0 Unported License, and converted with [iConvertIcons](https://iconverticons.com/online/).

BIN
assets/project/assets/pd.icns


BIN
assets/project/assets/pd.ico


BIN
assets/project/assets/pd.png


+ 7 - 2
assets/project/package.json

@@ -23,11 +23,13 @@
         "ProductName": "Project",
         "CompanyName": "nwjs-builder-phoenix",
         "LegalCopyright": "copyright"
-      }
+      },
+      "icon": "./assets/pd.ico"
     },
     "mac": {
       "displayName": "Project",
-      "copyright": "copyright"
+      "copyright": "copyright",
+      "icon": "./assets/pd.icns"
     },
     "nsis": {
       "diffUpdaters": true
@@ -36,5 +38,8 @@
   "devDependencies": {
     "nwjs-builder-phoenix": "github:evshiron/nwjs-builder-phoenix",
     "typescript": "^2.2.1"
+  },
+  "window": {
+    "icon": "./assets/pd.png"
   }
 }

+ 1 - 1
docs/FAQs.md

@@ -9,7 +9,7 @@ If you want to reduce the amount of files, try using `webpack` or something like
 
 > Icons on Windows?
 
-* Prepare different sizes (e.g. 32x32, 48x48, 64x64, 128x128, 256x256, etc.) of `.png`s and use `icotool` or some other tools to create a proper `.ico` file.
+* Prepare an `.png` file with 256x256 resolution, and use [iConvertIcons](https://iconverticons.com/online/) or something like that to generate ready-to-use `.ico` and `.icns`.
 * Set `package.json:build.win.icon` to the path of the `.ico` file.
 * Set `package.json:window.icon` to the path of a `.png` file.
 * Save and build.

+ 4 - 4
docs/Options.md

@@ -25,7 +25,7 @@ Name | Type | Description
 productVersion | string | Product version. Defaults to `${ version }`.
 fileVersion | string | File version. Defaults to `${ productVersion }`
 versionStrings | { [key: string]: string } | `rcedit` version strings. Defaults to `{ ProductName: "${ name }", FileDescription: "${ description }" }`.
-icon | string | .ico icon file. Defaults to `undefined`.
+icon | string | .ico icon file relative to the project root. Defaults to `undefined`.
 
 ## build.mac <- [MacConfig](../src/lib/config/MacConfig.ts)
 
@@ -36,7 +36,7 @@ displayName | string | DisplayName in `Info.plist`. Defaults to `${ name }`.
 version | string | Version in `Info.plist`. Defaults to `${ version }`.
 description | string | Description in `InfoPlist.strings`. Defaults to `${ description }`.
 copyright | string | Copyright in `InfoPlist.strings`. Defaults to `""`.
-icon | string | .icns icon file. Defaults to `undefined`.
+icon | string | .icns icon file relative to the project root. Defaults to `undefined`.
 
 ## build.linux <- [LinuxConfig](../src/lib/config/LinuxConfig.ts)
 
@@ -46,8 +46,8 @@ Currently noop.
 
 Name | Type | Description
 --- | --- | ---
-icon | string | .ico icon file for NSIS installers. Defaults to `undefined`.
-unIcon | string | .ico icon file for NSIS uninstallers. Defaults to `undefined`.
+icon | string | .ico icon file for NSIS installers relative to the project root. Defaults to `undefined`.
+unIcon | string | .ico icon file for NSIS uninstallers relative to the project root. Defaults to `undefined`.
 languages | string[] | Languages for NSIS installers. Multiple languages will result in a language selection dialog on startup. See [/assets/nsis/Contrib/Language files/](../assets/nsis/Contrib/Language%20files/) for available values. Defaults to `[ 'English' ]`.
 diffUpdaters | boolean | Whether to build diff updaters. Defaults to `false`.
 hashCalculation | boolean | Whether to calculate hashes for installers and updaters. Defaults to `true`.