hrfee/jfa-go
1
0
Fork 0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-11-22 18:30:11 +00:00
Code Issues Projects Releases Wiki Activity

Updated Build (markdown)

Harvey Tindall 2021-02-17 11:33:27 +00:00
parent 9105a2f152
commit 82c4b65607
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Build.md

@ -21,7 +21,7 @@ To build, you need to compile the typescript and go, and generate email template
``` ```
git git
python >= 3.6 python >= 3.6
go >= 1.15 go >= 1.16
node.js and npm (for tsc/esbuild and mjml) node.js and npm (for tsc/esbuild and mjml)
upx (optional, to compress the executable) upx (optional, to compress the executable)
``` ```
@ -29,6 +29,7 @@ The main dependencies of the program will be automatically downloaded on compila
### Makefile ### 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. 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.
* By default, `make all` will embed the program's assets inside the binary. If you want jfa-go to use external assets, use `make all-external` instead, and they will be placed next to the executable in `data/`.
* If you get an error from npm regarding esbuild, this is because a precompiled binary for your system's architecture isn't available on npm. run `make all GOESBUILD=on` instead to have it compiled instead. * If you get an error from npm regarding esbuild, this is because a precompiled binary for your system's architecture isn't available on npm. run `make all GOESBUILD=on` instead to have it compiled instead.