Skip to content

Commit

Permalink
add docs for windows cli installer
Browse files Browse the repository at this point in the history
  • Loading branch information
trappitsch committed Apr 12, 2024
1 parent 15b92c2 commit 7226f36
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion docs/.includes/installer_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,21 @@

=== "Windows"

CLI installers on Windows are currently not supported.
Windows installers are created using
[NSIS](https://nsis.sourceforge.io/Main_Page).
You must ensure that NSIS is installed and available on the system path.
The installer is an executable in `target/release/projectname-v1.2.3-win.exe`
that can be run by double-clicking it.

The installer will ask the user for the target directory.
It will then copy the binary to the target directory and create an uninstaller.

When using the uninstaller that is created with NSIS, all PyApp data from this project will be removed as well in order to provide the user with a clean uninstallation.

!!! warning
The installer will not add the install directory to the `PATH` variable.
You or the user must do this manually.
This is also stated on the last page of the installer.

=== "macOS"

Expand Down

0 comments on commit 7226f36

Please sign in to comment.