From 806be2f9e8c1b7402aa7adc7a4b79fa224f5d905 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Fri, 29 Jan 2021 17:19:29 +0000 Subject: [PATCH] Updated Build (markdown) --- Build.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Build.md b/Build.md index d383626..abd1c6e 100644 --- a/Build.md +++ b/Build.md @@ -1,9 +1,9 @@ -To build, you need to compile the typescript and sass, and generate email templates and config files. The build scripts were mostly ripped out of jf-accounts, so you'll need similar dependencies: +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 python >= 3.6 -pip (to install libsass) -node.js and npm (for tsc/esbuild, bootstrap4/5, autoprefixer, cleancss, mjml, and postcss) +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) @@ -13,6 +13,6 @@ A Makefile is provided, which requires the `make` command. Simply clone the repo ### Goreleaser [goreleaser](https://github.com/goreleaser/goreleaser) is used to publish the packages seen in the release section. -* To generate executables for multiple platforms, run `goreleaser build --snapshot --rm-dist`. They will be stored in `dist/`. The `data` directory must be manually copied into the same directory as the executable for it to run. +* To generate executables for multiple platforms, run `goreleaser build --snapshot --rm-dist`. They will be stored in `dist/`. The `data/` directory must be manually copied into the same directory as the executable for it to run. * To generate package archives that include `data`, run `goreleaser --snapshot --skip-publish --rm-dist`.