j/Mind_Reader
1
0
Fork 0
mirror of https://github.com/We-Dont-Byte/Mind_Reader.git synced 2024-11-15 03:35:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add reasons to DIG

John 2022-05-10 14:02:13 -05:00
parent bdf93977fa
commit 061c26b195
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
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 <NodeJS 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 <Electron 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.