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
Page: Developer Install Guide
Pages
Developer Install Guide Features List Getting Started Home Implementation Manual Project Roadmap
3 Developer Install Guide
John Breaux edited this page 2022-05-10 14:02:13 -05:00
Table of Contents

Automated install script

Windows 10 or 11

  • Download 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
  • 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

  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 <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)

  6. Change to your git directory, or create one. I recommend C:/Users/<username>/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 <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.

Windows 10

  1. Install/update Git for Windows

  2. Open VS Code, and go to Help > About in the top toolbar.

  3. Install the version of NodeJS.LTS corresponding to your Visual Studio Code version. This can be found in the About page.

  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/<username>/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 <Electron version>)

  10. Repeat steps 4-8 each time Visual Studio Code updates.