Skip to content

Commit

Permalink
📝 Document new configuration fields used for tweaking metadata of Win…
Browse files Browse the repository at this point in the history
…dows executables (#348)

* 📝 Document new configuration fields used for tweaking metadata of Windows executables

* 🐛 Fix word salad.
  • Loading branch information
CosmoMyzrailGorynych authored Sep 24, 2024
1 parent b08d2ec commit e7248d4
Showing 1 changed file with 35 additions and 0 deletions.
35 changes: 35 additions & 0 deletions docs/configuration/neutralino.config.json.md
Original file line number Diff line number Diff line change
Expand Up @@ -383,3 +383,38 @@ Sets the build path for neu CLI. For example, if you need to get the built binar
}
```
The default value for `distributionPath` is `/dist`.

## Windows-specific options
There are additional configuration options that define metadata and appearance of executables for Windows platform. These fields must be placed in the root of `neutralino.config.json`. Every field is optional.

### `applicationName: string`
The human-readable application name. Fills in the `ProductName` field of the executable.

### `applicationIcon: string`
The location of the executable's icon relative to `neutralino.config.json`. The icon must be in PNG format. If it is not set, an icon from `modes.window.icon` will be chosen instead. If `modes.window.icon` does not point to a PNG file, too, a default Neutralino.js icon will be used.

### `author: string`
The developer of the application. Fills in the `CompanyName` field of the executable.

### `description: string`
A description of the executable file. This usually describes the purpose of your application. Fills in the `FileDescription` field of the executable.

### `copyright: string`
Copyright information. Fills in the `LegalCopyright` field of the executable.

Example configuration:

```json
{
"applicationId": "cook.pancake.bakery",
"version": "1.2.0",
"applicationName": "Pancake Bakery",
"author": "Sweet Pancakes LLC",
"description": "Digital recipe book for pancakes from all over the world",
"copyright": "Copyright © Sweet Pancakes LLC 2042. All rights reserved.",
"applicationIcon": "buildAssets/appIcon.png",
"cli": {
"binaryName": "pancakebakery"
}
}
```

0 comments on commit e7248d4

Please sign in to comment.