From 8689035408df64c33cba2dd6bbc713870d7d6dda Mon Sep 17 00:00:00 2001 From: John Breaux Date: Tue, 10 May 2022 13:43:04 -0500 Subject: [PATCH] Add instructions to Developer-Install-Guide --- Developer-Install-Guide.md | 51 ++++++++++++++++++++++++++++++-------- 1 file changed, 40 insertions(+), 11 deletions(-) diff --git a/Developer-Install-Guide.md b/Developer-Install-Guide.md index e595841..5feb7cd 100644 --- a/Developer-Install-Guide.md +++ b/Developer-Install-Guide.md @@ -1,26 +1,55 @@ ## Automated install script ### Windows 10 or 11 -###### //TODO: Specific instructions for this platform -Run the install script +* Download [install-windows.ps1](../blob/johnBreaux/setup-development/windows/install-windows.ps1) +* Run `./install-windows.ps1` in PowerShell as a normal user, and accept any UAC prompts that pop up. The installation should take around 8 minutes. If an installer doesn't pop up, don't be alarmed. -### Ubuntu or Arch Linux -###### //TODO: Specific instructions for this platform +### Ubuntu, Linux Mint, Arch Linux, Manjaro +* Download [install-linux.sh](../blob/johnBreaux/setup-development/linux/linux-install.sh) +* Run `install-linux.sh` as a normal user. It will use sudo when elevation is required. The installation should be done in 3 minutes. ## Manual install ### Windows #### Windows 11 -###### //TODO: Specific instructions for this platform +1. Open Powershell in Windows Terminal (Commands will be in parentheses) + +2. Open VS Code, and go to `Help` > `About` in the top toolbar. + +3. Install/update Git for Windows (`winget install Git.Git`) + +4. Install the version of NodeJS.LTS corresponding to your Visual Studio Code version. This can be found in `Help` > `About` in the toolbar. (`winget install OpenJS.NodeJS.LTS --version `) + +5. Use node package manager to install `electron-rebuild` and `vsce` (`npm install -g electron-rebuild vsce`) + +6. Change to your git directory, or create one. I recommend `C:/Users//git`; i.e. `C:/Users/example/git` + +7. Clone the repository using (`git clone https://github.com/We-Dont-Byte/Mind_Reader.git`) + +8. Install dependencies (`npm install`) + +9. Rebuild Electron using the Electron Version from the About page. (`electron-rebuild --version `) + +10. Repeat steps 5-8 each time Visual Studio Code updates. #### Windows 10 -###### //TODO: Specific instructions for this platform +1. Install/update Git for Windows -### Linux +2. Open VS Code, and go to `Help` > `About` in the top toolbar. -#### Debian, Ubuntu -###### //TODO: Specific instructions for this platform +3. Install the version of NodeJS.LTS corresponding to your Visual Studio Code version. This can be found in the About page. -#### Arch Linux, Manjaro, Garuda Linux -###### //TODO: Specific instructions for this platform +4. Open Windows Powershell (Win+R, "powershell", Enter) + +5. Use node package manager to install `electron-rebuild` and `vsce` (`npm install -g electron-rebuild vsce`) + +6. Change to your git directory, or create one. I recommend `C:/Users//git`; i.e. `C:/Users/example/git` + +7. Clone the repository using (`git clone https://github.com/We-Dont-Byte/Mind_Reader.git`) + +8. Install dependencies (`npm install`) + +9. Rebuild Electron using the Electron Version from the About page. (`electron-rebuild --version `) + +10. Repeat steps 4-8 each time Visual Studio Code updates. \ No newline at end of file