From c39d4d4d40f82e112204e8b82ce87f773ce66575 Mon Sep 17 00:00:00 2001 From: Stash Dev Date: Sat, 9 Feb 2019 17:07:39 -0800 Subject: [PATCH] README update --- README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 74cb16d8c..02e619ed2 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,29 @@ TODO TODO -## Development +# Development -### Commands +## Environment + +### macOS + +TODO + +### Windows + +1. Download and install [Go for Windows](https://golang.org/dl/) +2. Download and install [MingW](https://sourceforge.net/projects/mingw-w64/) +3. Search for "advanced system settings" and open the system properties dialog. + 1. Click the `Environment Variables` button + 2. Add `GO111MODULE=on` + 3. Under system variables find the `Path`. Edit and add `C:\Program Files\mingw-w64\*\mingw64\bin` (replace * with the correct path). + +## Commands * `make build` - Builds the binary * `make gqlgen` - Regenerate Go GraphQL files -### Building a release +## Building a release 1. cd into the UI directory and run `ng build --prod` 2. cd back to the root directory and run `make build` to build the executable