commit 07c235a76a7265b74e8b1d8905e5f20e463a5050 Author: Harvey Tindall Date: Sun Aug 2 02:26:08 2020 +0100 Build instructions added diff --git a/Build.md b/Build.md new file mode 100644 index 0000000..b93cc6e --- /dev/null +++ b/Build.md @@ -0,0 +1,14 @@ +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: +``` +python >= 3.6 +pip (to install libsass) +node.js and npm (for bootstrap4/5, autoprefixer, cleancss, mjml, and postcss) +``` + +If you aren't using [goreleaser](https://goreleaser.com), run each command listed under `before: hooks:` in `.goreleaser.yml`, then `go build`. + +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`.