From 53cd02326d752045470c01b2a17fc8e9023d1d1e Mon Sep 17 00:00:00 2001 From: Conner Giordano Date: Mon, 13 Feb 2023 13:15:08 -0500 Subject: [PATCH] Added installation instructions for windows --- INSTALLING.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/INSTALLING.md b/INSTALLING.md index 37d9b72..c47a610 100644 --- a/INSTALLING.md +++ b/INSTALLING.md @@ -21,8 +21,28 @@ You may need to need to change the version number (`4.4.0`) and the archive See the [releases page][releases] for a list of supported platforms. #### Windows -TODO: community support is requested here. Please open a PR if you'd like to -contribute installation instructions for Windows. +First, you must download the executable for Windows using this command: +```sh +Invoke-WebRequest -Uri https://github.com/cheat/cheat/releases/download/4.4.0/cheat-windows-amd64.exe.zip -OutFile cheat-windows-amd64.exe.zip +``` +You may need to need to change the version number (`4.4.0`) if a newer version is released. + +This will download the resource into the zipped folder cheat-windows-amd64.exe.zip. + +Next, extract the contents of the newly created .zip file and navigate to the cheat-windows-amd64.exe application. + +Next, rename the executable to "cheat.exe" + +Now, run the application and type "y" to the prompts given to you. +This will create the config file and download the community cheatsheets into this directory: C:\\Users\\[user]\\AppData\\Roaming\\cheat + +Next, move the executable cheat.exe to the directory mentioned above. + +Now, go to Settings > System > About > Advanced System Settings > Environmental Variables +In the bottom panel, look for the Path variable, then click Edit. +Click New, then copy and paste the location of the "cheat" directory. By default, the location is C:\\Users\\[user]\\AppData\\Roaming\\cheat + +Note that you may change the location of the "cheat" directory. Just make sure that you also change the path in Environmental Variables. ### Install via `go install` If you have `go` version `>=1.17` available on your `PATH`, you can install