Mirrors/velopack
1
0
Fork 0
mirror of https://github.com/velopack/velopack.git synced 2025-10-25 15:19:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed some path issues and added naming info

Browse Source
This commit is contained in:
Jake Ginnivan
2016-01-13 10:00:58 +08:00
parent 1bd9ac699c
commit 09a835d3f1
3 changed files with 33 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -26,6 +26,11 @@ Refer to our full list of goals for [integrating, packaging, distributing, insta
See the documentation [Table of Contents](docs/readme.md) for an overview of the available documentation for Squirrel.Windows. It includes a [Getting Started Guide](docs/getting-started/0-overview.md) as well as additional topics related to using Squirrel in your applications.
## Building Squirrel from source
See the [contributing documentation](docs/contributing/contributing.md)
## License and Usage
See [COPYING](COPYING) for details on copyright and usage of the Squirrel.Windows software.

11
docs/using/install-process.md
View File

@@ -1,9 +1,9 @@
| [docs](..) / [using](.) / install-process.md
|:---|
# Install Process
This section goes into detail about the install process.
# Install Process
This section goes into detail about the install process.
## Setup.exe
@@ -49,7 +49,7 @@ The `Setup.exe` application preforms the following:
4. **Executes `Update.exe` to Finish Install** - executes the `Updater.exe` application with the `/install` switch to finish the application installation and then launch the application.
1. **Copy MyApp to `app-1.0.0` Directory** - copy the full version of MyApp files to a application sub-directory (e.g., `MyApp\app-1.0.0`).
2. **Launch MyApp** - at the end of the setup process, the Updater launches the newly installed version of MyApp.
6. **MyApp Creates Shortcuts** - the first execution of the application will cause shortcuts to be created on the desktop and Windows start menu for MyApp.
6. **MyApp Creates Shortcuts** - the first execution of the application will cause shortcuts to be created on the desktop and Windows start menu for MyApp.
## Desktop & Windows Start Shortcuts
@@ -65,7 +65,8 @@ By default, application shortcuts are created on the desktop and the Windows Sta
* [Loading GIF](loading-gif.md) - specify a "loading" image during initial install of large applications.
* [Machine-wide Installs](machine-wide-installs.md) - generating an MSI file suitable for installation via Group Policy.
* [NuGet Package Metadata](using/nuget-package-metadata.md) - overview of the NuGet metadata and its uses by Squirrel.
* [NuGet Package Metadata](nuget-package-metadata.md) - overview of the NuGet metadata and its uses by Squirrel.
* [Naming sources](naming.md) - A more complete view of how Squirrel names everything.
---
| Return: [Table of Contents](../readme.md) |

22
docs/using/naming.md Normal file
View File

@@ -0,0 +1,22 @@
| [docs](..) / [using](.) / naming.md
|:---|
# 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:
## 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
1. `%appdata%/<nugetpackageid>` - **NOTE** Using .'s in your pacakge id will cause issues
## Program and Features entry
1. Squirrel Package `title`
---
| Return: [Table of Contents](../readme.md) |
|----|