From 72f47a1718d88cf02240934d4fbf977cfd3dcf0b Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Tue, 1 Jun 2021 00:37:33 +0100 Subject: [PATCH] Updated Build (markdown) --- Build.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/Build.md b/Build.md index 5b064da..1fde813 100644 --- a/Build.md +++ b/Build.md @@ -24,6 +24,7 @@ python >= 3.6 go >= 1.16 node.js and npm (for tsc/esbuild and mjml) upx (optional, to compress the executable) +libappindicator3-dev or equivalent (only needed if building with tray icon) ``` 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). @@ -33,6 +34,7 @@ A Makefile is provided, which requires the `make` command. Simply clone the repo * `DEBUG=on`: doesn't strip binaries and includes typescript sourcemaps. * `INTERNAL=off`: Defaults to on, this disables embedding so assets are stored in the `data/` folder next to the binary. Useful for customizing after compilation. * `UPDATER=on/off/docker`: Enables/disables the updater, which pings [build.hrfee.pw](https://builds.hrfee.pw) every 30 mins for new updates. New updates are shown with a download link to the user. When `INTERNAL=on`, updates are automatically downloaded, and installed upon request. + * `TRAY=on`: Enables a tray icon, which lets you start/stop/autostart on login. For linux, requires `libappindicator3-dev` for debian or the equivalent on other distributions. * 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.