mirror of
https://github.com/We-Dont-Byte/Mind_Reader.git
synced 2024-11-15 03:35:59 +00:00
Add README.md
This commit is contained in:
parent
214610340f
commit
ba6e27cb9e
35
README.md
Normal file
35
README.md
Normal file
@ -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)
|
||||||
|
(<kbd>F5</kbd> by default).
|
Loading…
Reference in New Issue
Block a user