From f71a2daf31ad3ea1ce2e3d4e29c9ab0c0bff63b8 Mon Sep 17 00:00:00 2001 From: Carlos Alexandro Becker Date: Mon, 1 May 2017 11:07:05 -0300 Subject: [PATCH] improving docs --- README.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1ad52b055..337b55f9d 100644 --- a/README.md +++ b/README.md @@ -57,7 +57,10 @@ func main() { } ``` -By default GoReleaser will build the **main.go** file located in your current directory, but you can change the build package path in the GoReleaser configuration file. +By default GoReleaser will build the your current directory, but you can change the build package path in the GoReleaser configuration file. + +To generate a `goreleaser.yml` file with the defaults, you can run `goreleaser init`. +You can then custumize the sections as you wish. ```yml # goreleaser.yml @@ -108,7 +111,7 @@ archive: This configuration will generate tar archives, contains an additional file `drum-roll.licence.txt`, the archives will be located in: -- `./dist/drum-roll_windows_64-bit.tar.gz` +- `./dist/drum-roll_windows_64-bit.zip` - `./dist/drum-roll_macOS_64-bit.tar.gz` - `./dist/drum-roll_Tux_64-bit.tar.gz` @@ -251,6 +254,13 @@ archive: # Default is `tar.gz` format: zip + # Can be used to archive on different formats for specific GOOSs. + # Most common use case is to archive as zip on Windows. + # Default is empty + format_overrides: + - goos: windows + format: zip + # Replacements for GOOS and GOARCH on the archive name. # The keys should be valid GOOS or GOARCH values followed by your custom # replacements.