mirror of
https://github.com/velopack/velopack.git
synced 2025-10-25 15:19:22 +00:00
Add link for Naming Conventions in table of contents.
Add some additional text to naming.md and an image Update nuget-package-metadata.md to link to naming and contain more info.
This commit is contained in:
@@ -35,6 +35,7 @@ The **[Getting Started Guide](getting-started/0-overview.md)** provides a step-b
|
|||||||
* [Machine-wide Installs](using/machine-wide-installs.md) - generating an MSI file suitable for installation via Group Policy.
|
* [Machine-wide Installs](using/machine-wide-installs.md) - generating an MSI file suitable for installation via Group Policy.
|
||||||
* [Debugging Installs](using/debugging-installs.md) - tips for debugging Squirrel.Windows initial installs.
|
* [Debugging Installs](using/debugging-installs.md) - tips for debugging Squirrel.Windows initial installs.
|
||||||
* **Packaging** - documentation related to packaging app files and preparing them for release.
|
* **Packaging** - documentation related to packaging app files and preparing them for release.
|
||||||
|
* [Naming Conventions](using/naming.md) - overview of sources used in naming (e.g., shortcut name).
|
||||||
* [NuGet Package Metadata](using/nuget-package-metadata.md) - overview of the NuGet metadata and its uses by Squirrel.
|
* [NuGet Package Metadata](using/nuget-package-metadata.md) - overview of the NuGet metadata and its uses by Squirrel.
|
||||||
* [Squirrel Command Line](using/squirrel-command-line.md) - command line options for `Squirrel --releasify`
|
* [Squirrel Command Line](using/squirrel-command-line.md) - command line options for `Squirrel --releasify`
|
||||||
* [Delta Packages](using/delta-packages.md) - an overview of how `Squirrel.exe` creates delta packages.
|
* [Delta Packages](using/delta-packages.md) - an overview of how `Squirrel.exe` creates delta packages.
|
||||||
|
|||||||
BIN
docs/using/images/naming-releases.png
Normal file
BIN
docs/using/images/naming-releases.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 20 KiB |
@@ -1,21 +1,44 @@
|
|||||||
| [docs](..) / [using](.) / naming.md
|
| [docs](..) / [using](.) / naming.md
|
||||||
|:---|
|
|:---|
|
||||||
|
|
||||||
# Naming conventions
|
# Naming Conventions
|
||||||
|
|
||||||
In addition to the [nuget-package-metadata](nuget-package-metadata.md), there are other places that squirrel pulls naming information from. Here is the logic:
|
In addition to the [NuGet Package Metadata](nuget-package-metadata.md), there are other places that squirrel pulls naming information from. Here is the logic:
|
||||||
|
|
||||||
## Shortcut name
|
## Shortcut name
|
||||||
1. Use `[assembly: AssemblyProduct("MyApp")` from your exe
|
|
||||||
2. Squirrel Package `title`
|
|
||||||
3. Use `[assembly: AssemblyDescription("MyApp")`
|
|
||||||
4. Your exe filename
|
|
||||||
|
|
||||||
## Install location
|
The shortcut name is selected from the first non-null item below:
|
||||||
1. `%appdata%/<nugetpackageid>` - **NOTE** Using .'s in your package id will cause issues
|
|
||||||
|
|
||||||
## Program and Features entry
|
1. `[assembly: AssemblyProduct("MyApp")` (from `AssemblyInfo.cs`)
|
||||||
1. Squirrel Package `title`
|
2. Squirrel NuGet Package Metadata `title` property.
|
||||||
|
3. `[assembly: AssemblyDescription("MyApp")` (from `AssemblyInfo.cs`)
|
||||||
|
4. Filename of the Exe (e.g., MyApp)
|
||||||
|
|
||||||
|
## Local Install location
|
||||||
|
|
||||||
|
The local install location is determined by the `id` in the NuGet package metadata.
|
||||||
|
|
||||||
|
* `%LocalAppData%\<NuGet Package ID>`
|
||||||
|
|
||||||
|
**Warning:** Using \[dots\] (i.e., "."'s) in your package id will cause issues ([see issue #523](https://github.com/Squirrel/Squirrel.Windows/issues/523)).
|
||||||
|
|
||||||
|
## Program and Features Entry
|
||||||
|
The entry in the Windows Uninstall is determined as follows:
|
||||||
|
|
||||||
|
* Squirrel NuGet Package Metadata `title` property
|
||||||
|
|
||||||
|
## Releases Folder
|
||||||
|
|
||||||
|
The `Squirrel --releasify` command will create update packages based on the following:
|
||||||
|
|
||||||
|
* `<NuGet Package ID>-<NuGet Package Version>-delta.nupkg`
|
||||||
|
* `<NuGet Package ID>-<NuGet Package Version>-full.nupkg`
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
* [NuGet Package Metadata](nuget-package-metadata.md) - naming from the NuGet Package Metadata perspective.
|
||||||
|
|
||||||
---
|
---
|
||||||
| Return: [Table of Contents](../readme.md) |
|
| Return: [Table of Contents](../readme.md) |
|
||||||
|
|||||||
@@ -5,13 +5,21 @@
|
|||||||
|
|
||||||
Squirrel uses information from your app's EXE as well as the NuGet package Metadata for the setup and uninstall UI.
|
Squirrel uses information from your app's EXE as well as the NuGet package Metadata for the setup and uninstall UI.
|
||||||
|
|
||||||
* **Id** - name of the application (no spaces or [dots](https://github.com/Squirrel/Squirrel.Windows/issues/523)). Used to name the release packages (e.g., **MyApp**-1.0.0-full.nupkg).
|
* **Id** - name of the application (**warning:** you must **[avoid using spaces and dots](https://github.com/Squirrel/Squirrel.Windows/issues/523)** in the Id).
|
||||||
|
* Name of the release packages (e.g., **MyApp**-1.0.0-full.nupkg).
|
||||||
|
* Local installation directory (e.g., `%LocalAppData%\MyApp`).
|
||||||
* **Title** - used for the name of the application in the Windows Application Uninstaller.
|
* **Title** - used for the name of the application in the Windows Application Uninstaller.
|
||||||
* **Version** - version specified in `Properties\Assembly.cs`. Used for naming the release package(e.g., MyApp-**1.0.0**-full.nupkg) as well as describing the version number in the Windows Uninstaller (see screenshot below).
|
* **Version** - version specified in `Properties\Assembly.cs`.
|
||||||
|
* Name of the release package (e.g., MyApp-**1.0.0**-full.nupkg).
|
||||||
|
* Version number in the Windows Uninstaller (see screenshot below).
|
||||||
* **Icon Url** - url to an icon to be used for the application. Used for the shortcuts and Windows Uninstaller icons.
|
* **Icon Url** - url to an icon to be used for the application. Used for the shortcuts and Windows Uninstaller icons.
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
|
## See Also
|
||||||
|
|
||||||
|
* [Naming Conventions](naming.md) - overview of sources used naming (including those outside of the NuGet Package Metadata).
|
||||||
|
|
||||||
---
|
---
|
||||||
| Return: [Table of Contents](../readme.md) |
|
| Return: [Table of Contents](../readme.md) |
|
||||||
|----|
|
|----|
|
||||||
|
|||||||
Reference in New Issue
Block a user