diff --git a/README.md b/README.md index 874a6ff..b89dd56 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

-Mind Reader Logo +Mind Reader Logo

Mind_Reader

@@ -34,14 +34,65 @@ Python programming with LEGO Mindstorms. Our goal is to: - Save and load programs directly onto the LEGO Hub from within Visual Studio Code -# For Developers - ## Dependencies - - - [Git](https://git-scm.com/) - [Node.js](https://nodejs.org/en/) +If the compiled serial port version is incompatible, you may see no options presented in the Mind_Reader actions panel: + +

+mind reader actions panel with no items: +

+ +In this case, you will also need to rebuild the serial port component with `electron-rebuild`. This is a one-time setup +for each installation of Visual Studio Code. + +## Installing `electron-rebuild` +**Use Git Bash on Windows, and the terminal on MacOS/Linux. These steps will refer to this as 'the terminal'** + +### 1 Install the `electron-rebuild` tool +In the terminal install electron rebuild with `npm` that is included with [Node.js](https://nodejs.org/en/): + +```console +$ npm install -g electron-rebuild +``` + +### 2 Finding your electron version +On MacOS, go to Code > About Visual Studio Code. + +On Windows and Linux, go to Help > About. + +The electron version should be listed, e.g.: `Electron: 13.5.2` + +

+vscode information +

+ +### 3 Finding the Mind_Reader extension directory +On MacOS and Linux this is `~/.vscode/extensions`. + +On Windows this is `C:\\.vscode\extensions\`. However, in Git Bash, it will appear like on MacOS and Linux +e.g.: `~/.vscode/extensions`. + +--- + +Find the Mind_Reader extension folder, this should look like `xxx.mind-reader-x.x.x`. + +Navigate to the found folder in the terminal. + +```console +$ cd ~/.vscode/extensions/ +``` + +### 4 Running `electron-rebuild` + +Then, run `electron-rebuild` with `ELECTRON_VERSION` replaced with the electron version found in step 2: + +```console +$ electron-rebuild --version=ELECTRON_VERSION +``` + +# For Developers ## Development Quick Start Use the following to set up the extension for development. diff --git a/media/missing_actions.png b/media/missing_actions.png new file mode 100644 index 0000000..6fcd5ca Binary files /dev/null and b/media/missing_actions.png differ diff --git a/media/vscode_info.png b/media/vscode_info.png new file mode 100644 index 0000000..fcd941f Binary files /dev/null and b/media/vscode_info.png differ