diff --git a/development_docs/README.md b/development_docs/README.md new file mode 100644 index 0000000000..06bbe319e4 --- /dev/null +++ b/development_docs/README.md @@ -0,0 +1,5 @@ +Development Docs +================ + +These documents speak more in depth to setup, individual platform installation, code conventions, and more. + diff --git a/development_docs/windows.md b/development_docs/windows.md new file mode 100644 index 0000000000..b9f9a43145 --- /dev/null +++ b/development_docs/windows.md @@ -0,0 +1,23 @@ +Windows-specific notes +====================== + +Setting up the development environment +-------------------------------------- + +### Install NVM / NPM + +1. Install [Windows nvm](https://github.com/coreybutler/nvm-windows/releases) +2. Run `nvm install latest` (which is version "18.6.0" at time of writing) +3. Run `nvm use (version number)` from an Administrator console. + To enable admin rights, right click and run the terminal as administrator. + +### Install Yarn + +1. Run `npm i -g corepack` from an Administrator console. +2. Run `yarn init -2` from the repository. + + +Running the project +-------------------- + +1. Run `yarn install` \ No newline at end of file