From 447c77c86c684a6553238c7f57223bd30aa1dc44 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 18 Aug 2020 15:28:59 +0100 Subject: [PATCH] Updated Build (markdown) --- Build.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Build.md b/Build.md index fcc030d..a25b765 100644 --- a/Build.md +++ b/Build.md @@ -4,11 +4,11 @@ python >= 3.6 pip (to install libsass) node.js and npm (for bootstrap4/5, autoprefixer, cleancss, mjml, and postcss) ``` +### 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/`. -If you aren't using [goreleaser](https://goreleaser.com), you can instead run `make all` to build, which will place it's output in `build/`. If you don't want to use that either, run each command listed under `before: hooks:` in `.goreleaser.yml`, then `go build`. +### 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. -If you are: - -* To generate executables, run `goreleaser build --snapshot --rm-dist`. This will place executables in `dist/`. The `data` directory must be copied into the same directory as the executable for it to run. - -* To generate package archives, run `goreleaser --snapshot --skip-publish --rm-dist`. +* To generate package archives that include `data`, run `goreleaser --snapshot --skip-publish --rm-dist`.