MailHog/docs/BUILD.md
Tyndyll abb0a89327
Update BUILD.md
Fix build doc Makefile link
2018-09-14 12:47:52 +01:00

29 lines
1 KiB
Markdown

Building MailHog
================
MailHog is built using `make`, and using [this Makefile](../Makefile).
If you aren't making any code changes, you can install MailHog using
`go get github.com/mailhog/MailHog`, since [mailhog/MailHog-UI/assets/assets.go](https://github.com/mailhog/MailHog-UI/blob/master/assets/assets.go)
is already pre-compiled and committed to this repository.
### Why do I need a Makefile?
MailHog has HTML, CSS and Javascript assets which need to be converted
to a go source file using [go-bindata](https://github.com/jteeuwen/go-bindata).
This must happen before running `go build` or `go install` to avoid compilation
errors (e.g., `no buildable Go source files in MailHog-UI/assets`).
### go generate
The build should be updated to use `go generate` (added in Go 1.4) to
preprocess static assets into go source files.
However, this will break backwards compatibility with Go 1.2/1.3.
### Building a release
Releases are built using [gox](https://github.com/mitchellh/gox).
Run `make release` to cross-compile for all available platforms.