diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7256bfd3..e1622143 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -50,7 +50,7 @@ Now that you're set up, feel free to check out our [Issues](https://github.com/v Beyond the extension, we very occasionally edit the IDE when we need to access more functionality. If you want to work on the full IDE, please follow the steps below, or see VS Code's full [how to contribute](https://github.com/microsoft/vscode/wiki/How-to-Contribute) page. -Before starting, make sure you've built the extension (by running `cd .\extensions\void\` and `npm run build`). +Before starting, make sure you've built the extension (by running `cd .\extensions\void\` and `npm run build`). Also make sure you have Python on your system. Make sure you're on the correct NodeJS version as per `.nvmrc`. diff --git a/extensions/void/README.md b/extensions/void/README.md index 04d86826..fd4840c4 100644 --- a/extensions/void/README.md +++ b/extensions/void/README.md @@ -1 +1,8 @@ Please see the `CONTRIBUTING.md` for information on how to contribute :)! + + +Here's an overview on how the extension works: + +- The extension mounts in `extension.ts`. + +- The Sidebar's HTML (everything in `sidebar/`) is built in React, and it's rendered by mounting a `