From 061c26b1959dfd8648bd54db58c73a6c56d3115c Mon Sep 17 00:00:00 2001 From: John Breaux Date: Tue, 10 May 2022 14:02:13 -0500 Subject: [PATCH] Add reasons to DIG --- Developer-Install-Guide.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Developer-Install-Guide.md b/Developer-Install-Guide.md index 5feb7cd..69b9dfb 100644 --- a/Developer-Install-Guide.md +++ b/Developer-Install-Guide.md @@ -1,11 +1,11 @@ ## Automated install script ### Windows 10 or 11 -* Download [install-windows.ps1](../blob/johnBreaux/setup-development/windows/install-windows.ps1) +* Download [install-windows.ps1](../blob/master/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, Linux Mint, Arch Linux, Manjaro -* Download [install-linux.sh](../blob/johnBreaux/setup-development/linux/linux-install.sh) +* Download [install-linux.sh](../blob/master/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 @@ -20,6 +20,7 @@ 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 `) + * This prevents a NODE_MODULE_VERSION conflict between Mind Reader and VSCode 5. Use node package manager to install `electron-rebuild` and `vsce` (`npm install -g electron-rebuild vsce`) @@ -30,6 +31,7 @@ 8. Install dependencies (`npm install`) 9. Rebuild Electron using the Electron Version from the About page. (`electron-rebuild --version `) + * This will rebuild the `serial_port` Node Native Module. Without this module, Mind Reader will fail to register its commands. 10. Repeat steps 5-8 each time Visual Studio Code updates.