From ba6e27cb9e57de27cd56f2e36af384590259af9f Mon Sep 17 00:00:00 2001 From: jakergrossman Date: Sat, 25 Sep 2021 16:21:23 -0500 Subject: [PATCH] Add README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..e5cecc5 --- /dev/null +++ b/README.md @@ -0,0 +1,35 @@ +# Mind_Reader +The current editor options available lack the level of accessibility that is +required to allow students who are visually impaired to adequately edit, write, +and debug code. This tool would extend Visual Studio Code’s existing +accessibility options to allow everyone, primarily students K-12, to learn +programming with Lego Mindstorms. Our goal is to provide an enhanced experience +for students who are visually impaired that is transparent to sighted students. +This allows for everyone to use the same software solution, whether or not they +are vision impaired. + + +## Dependencies +- [Git](https://git-scm.com/) +- [Node.js](https://nodejs.org/en/) + +See ["Your First +Extension"](https://code.visualstudio.com/api/get-started/your-first-extension) +API page if you need more help. + +## Cloning & Setup +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](https://code.visualstudio.com/api/advanced-topics/extension-host) +(F5 by default).