Begin keeping Windows and other development docs

This commit is contained in:
Brandon Thomas
2022-07-16 21:04:55 -04:00
parent 1f80c73e56
commit edaee99c40
2 changed files with 28 additions and 0 deletions
+5
View File
@@ -0,0 +1,5 @@
Development Docs
================
These documents speak more in depth to setup, individual platform installation, code conventions, and more.
+23
View File
@@ -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`