From 2c9422f05587dd6e2c1287061de1edf8ed2eed49 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 16 Feb 2021 18:22:22 +0000 Subject: [PATCH] Updated Build (markdown) --- Build.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Build.md b/Build.md index b64c2be..c8f48e3 100644 --- a/Build.md +++ b/Build.md @@ -15,6 +15,8 @@ To build and load the container, you can then run ``` ## Native +* Note: The build process doesn't really work on Windows, and I doubt there's a need for first class support. Your best bet is to build in WSL with either method below and the `GOOS=windows` environment variable set. + To build, you need to compile the typescript and go, and generate email templates and config files. The build scripts were mostly ripped out of jf-accounts, so you'll need similar dependencies: ``` git @@ -23,7 +25,7 @@ go >= 1.15 node.js and npm (for tsc/esbuild and mjml) upx (optional, to compress the executable) ``` -The main dependencies of the program will be automatically downloaded on compilation and can be seen in [go.mod](https://github.com/hrfee/jfa-go/blob/main/go.mod) +The main dependencies of the program will be automatically downloaded on compilation and can be seen in [go.mod](https://github.com/hrfee/jfa-go/blob/main/go.mod). ### Makefile A Makefile is provided, which requires the `make` command. Simply clone the repository and run `make all` to grab all necessary dependencies for go/python/node, compile everything and place the executable and app data inside `build/`. You can optionally compress the executable by running `make compress` after.