mirror of
https://github.com/We-Dont-Byte/Mind_Reader.git
synced 2024-11-15 03:35:59 +00:00
Add rebuild instructions
This commit is contained in:
parent
9d41e5c9be
commit
6b5c7d93f8
61
README.md
61
README.md
@ -1,6 +1,6 @@
|
|||||||
<!-- header with logo -->
|
<!-- header with logo -->
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<img alt="Mind Reader Logo" src="./media/logo.png"></img>
|
<img alt="Mind Reader Logo" src="media/logo.png"></img>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h1>Mind_Reader</h1>
|
<h1>Mind_Reader</h1>
|
||||||
@ -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
|
- Save and load programs directly onto the LEGO Hub from within Visual Studio Code
|
||||||
|
|
||||||
# For Developers
|
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
<!-- TODO: version information -->
|
|
||||||
<!-- TODO: how to support native-usb functionality? -->
|
|
||||||
- [Git](https://git-scm.com/)
|
- [Git](https://git-scm.com/)
|
||||||
- [Node.js](https://nodejs.org/en/)
|
- [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:
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img width="50%" height="50%" alt="mind reader actions panel with no items:" src="media/missing_actions.png"></img>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
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`
|
||||||
|
|
||||||
|
<p align="center">
|
||||||
|
<img width="35%" height="35%" alt="vscode information" src="media/vscode_info.png"></img>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
### 3 Finding the Mind_Reader extension directory
|
||||||
|
On MacOS and Linux this is `~/.vscode/extensions`.
|
||||||
|
|
||||||
|
On Windows this is `C:\<YOUR USER>\.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/<mind_reader_folder>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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
|
## Development Quick Start
|
||||||
Use the following to set up the extension for development.
|
Use the following to set up the extension for development.
|
||||||
|
|
||||||
|
BIN
media/missing_actions.png
Normal file
BIN
media/missing_actions.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 91 KiB |
BIN
media/vscode_info.png
Normal file
BIN
media/vscode_info.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 99 KiB |
Loading…
Reference in New Issue
Block a user