My Capstone project, continuing an earlier team's work on making VSCode more accessible. I created a ton of documentation for the project, including a Wiki, to aid in onboarding the team that came after us.
Go to file
John Breaux 51b19a7054
Merge pull request #5 from We-Dont-Byte/johnBreaux
package.json:

    Remove duplicate entries
    Unify names of submenus according to Mind Reader naming conventions
    Add keybinds for things I accidentally only had in my User configuration (oops!)
    Reorganize right-click context menu to group similar commands
    Add keybinds for items in the right-click context menu (or replace them with vscode builtins)
2022-05-07 23:27:07 -05:00
.github/workflows Improve github actions CI 2022-05-05 18:44:50 -05:00
.vscode Integrate Parser (#4) 2021-10-26 12:48:04 -05:00
media Mind_Reader -> Mind Reader 2022-05-05 20:56:10 -05:00
setup-development Update permissions on install scripts, for linux. 2022-05-07 13:24:46 -05:00
src added setup instructions 2022-05-07 13:31:34 -05:00
.eslintrc.json Initial commit 2021-09-25 16:18:41 -05:00
.gitignore Update .gitignore 2022-04-09 21:14:56 -05:00
.vscodeignore Initial commit 2021-09-25 16:18:41 -05:00
package-lock.json Update Mocha to version 10.0.0 2022-05-07 21:29:59 -05:00
package.json Add keybinds for all important menu items 2022-05-07 23:20:07 -05:00
README.md Mind_Reader -> Mind Reader 2022-05-05 20:56:10 -05:00
tsconfig.json Implement increasing font and editor scale 2021-10-16 19:30:40 -05:00

Mind Reader Logo

Mind Reader

The current editor options available lack the level of accessibility that is required to allow people who are visually impaired to adequately write, edit, and debug code.

This tool extends Visual Studio Codes existing accessibility options to enable people with a visual impairment to learn Python programming with LEGO Mindstorms. Our goal is to:

  • provide an accessible experience to people with a visual impairment

  • not change the editing workflow for people without a visual impairment

Major Features

  • Compatibility with major screen readers:

  • Present a summary of the scope for an individual line of code.

  • Save and load programs directly onto the LEGO Hub from within Visual Studio Code

Dependencies

NOTE: While installing Node.js, there will be a section titled "Tools for Native Modules". Make sure that 'Automatically install the necessary tools' is checked:

tools for native modules page with tool installation checked

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 version of Visual Studio Code. You may need to repeat this process if you update your version 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:

$ 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:\<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.

$ 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:

$ electron-rebuild --version=ELECTRON_VERSION

For Developers

Development Quick Start

Use the following to set up the extension for development.

$ git clone https://github.com/SingleSemesterSnobs/Mind Reader.git
$ cd Mind Reader
$ npm install

While inside the repository do

$ code .

to open the cloned repository in VS Code.

Then, use "Run > Start Debugging" on the menu bar to start the Extension Development Host (F5 by default).


If you get an error about a NODE_MODULE_VERSION incompatibility or that a file is not a Windows executable, this is likely the error described above. Run npm i -g electron-rebuild if you have not done so and follow the directions above.


See the Visual Studio Code getting started API page if you need more help.

Contact Information