From 3cc65890e1a2954953a404c01a6152b32ea226f4 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Thu, 3 Sep 2020 21:53:21 +0100 Subject: [PATCH] Updated Build (markdown) --- Build.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Build.md b/Build.md index a25b765..864a89f 100644 --- a/Build.md +++ b/Build.md @@ -1,14 +1,16 @@ To build, you need to generate email templates, css, 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 bootstrap4/5, autoprefixer, cleancss, mjml, and postcss) +upx (optional, to compress the executable) ``` ### Makefile -A Makefile is provided, which requires the `make` command. Simply clone the repository and run `make all` (or `make headless` for a non-interactive mode) to grab all necessary dependencies for go/python/node, compile everything and place the executable and app data inside `build/`. +A Makefile is provided, which requires the `make` command. Simply clone the repository and run `make all` (or `make headless` for a non-interactive mode) 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. ### 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 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`.