hrfee/jfa-go
1
0
Fork 0
mirror of https://github.com/hrfee/jfa-go.git synced 2024-11-22 10:20:11 +00:00
Code Issues Projects Releases Wiki Activity

Updated Build (markdown)

Harvey Tindall 2021-06-01 00:37:33 +01:00
parent a5314189d8
commit 72f47a1718
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
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.