From ebc4f3f4bf280ebc2409bd0a2cc313be42b86b09 Mon Sep 17 00:00:00 2001 From: Ana Hobden Date: Fri, 24 May 2024 12:05:08 -0700 Subject: [PATCH 1/2] Improve Windows instructions --- docs/src/install.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/src/install.rst b/docs/src/install.rst index a478a7d..35f6687 100644 --- a/docs/src/install.rst +++ b/docs/src/install.rst @@ -25,6 +25,8 @@ From a terminal run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ferrocene/criticalup/releases/latest/download/criticalup-installer.sh | sh +This will install CriticalUp into ``$HOME/.cargo/bin/criticalup``. + CriticalUp will install toolchains into ``$XDG_DATA_HOME/criticalup``, or if that environment variable is not set, ``$HOME/.local/share/criticalup``. @@ -38,16 +40,32 @@ From a terminal run: curl --proto '=https' --tlsv1.2 -LsSf https://github.com/ferrocene/criticalup/releases/latest/download/criticalup-installer.sh | sh +This will install CriticalUp into ``$HOME/.cargo/bin/criticalup``. + CriticalUp will install toolchains into ``$HOME/Library/Application Support/criticalup``. Windows ------- +MSI based +^^^^^^^^^ + +We recommend `downloading and installing the MSI `_. + +This will install CriticalUp into ``C:\Program Files\criticalup`` by default, but the location is configurable in the installer interface. + +If you'd prefer not to use the MSI, a powershell based install is available. + +Powershell based +^^^^^^^^^^^^^^^^ + From a terminal run: .. code-block:: powershell -c "irm https://github.com/ferrocene/criticalup/releases/latest/download/criticalup-installer.ps1 | iex" +This will install CriticalUp into ``$HOME/.cargo/bin/criticalup``. + CriticalUp will install toolchains into ``{FOLDERID_RoamingAppData}``, usually ``%appdata%\criticalup``. From 7163dabcc414d563ff49aa66869519cdc9c450c1 Mon Sep 17 00:00:00 2001 From: Ana Hobden Date: Fri, 24 May 2024 12:12:20 -0700 Subject: [PATCH 2/2] Include uninstall instructions --- docs/src/install.rst | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/docs/src/install.rst b/docs/src/install.rst index 35f6687..edb5cf5 100644 --- a/docs/src/install.rst +++ b/docs/src/install.rst @@ -27,9 +27,10 @@ From a terminal run: This will install CriticalUp into ``$HOME/.cargo/bin/criticalup``. -CriticalUp will install toolchains into ``$XDG_DATA_HOME/criticalup``, or if that +CriticalUp will create a state directory where it installs toolchains in ``$XDG_DATA_HOME/criticalup``, or if that environment variable is not set, ``$HOME/.local/share/criticalup``. +To uninstall, remove ``$HOME/.cargo/bin/criticalup`` then delete the state directory. MacOS ----- @@ -42,20 +43,26 @@ From a terminal run: This will install CriticalUp into ``$HOME/.cargo/bin/criticalup``. -CriticalUp will install toolchains into ``$HOME/Library/Application Support/criticalup``. +CriticalUp will create a state directory where it installs toolchains in ``$HOME/Library/Application Support/criticalup``. +To uninstall, remove ``$HOME/.cargo/bin/criticalup`` then delete the state directory. Windows ------- +We recommend using the MSI installation method. If you'd prefer not to use the MSI, a powershell based install is available. + MSI based ^^^^^^^^^ -We recommend `downloading and installing the MSI `_. +The recommended method of installation is to `download and run the MSI `_. This will install CriticalUp into ``C:\Program Files\criticalup`` by default, but the location is configurable in the installer interface. -If you'd prefer not to use the MSI, a powershell based install is available. +CriticalUp will create a state directory where it installs toolchains in +``{FOLDERID_RoamingAppData}``, usually ``%appdata%\criticalup``. + +To uninstall, use the Windows Add/Remove programs interface or run ``winget remove criticalup``, then delete the state directory. Powershell based ^^^^^^^^^^^^^^^^ @@ -68,4 +75,7 @@ From a terminal run: This will install CriticalUp into ``$HOME/.cargo/bin/criticalup``. -CriticalUp will install toolchains into ``{FOLDERID_RoamingAppData}``, usually ``%appdata%\criticalup``. +CriticalUp will create a state directory where it installs toolchains in +``{FOLDERID_RoamingAppData}``, usually ``%appdata%\criticalup``. + +To uninstall, remove ``$HOME/.cargo/bin/criticalup`` then delete the state directory. \ No newline at end of file