diff --git a/.gitignore b/.gitignore index 6805dbb..25a2ff9 100644 --- a/.gitignore +++ b/.gitignore @@ -18,5 +18,5 @@ helm_repos .DS_Store .idea .vscode -fab -fabrikate +/fab +/fabrikate diff --git a/README.md b/README.md index 884f6dc..f43254b 100644 --- a/README.md +++ b/README.md @@ -25,14 +25,33 @@ with the current set of applied resource manifests in your Kubernetes cluster. ## Installation -You can grab the latest releases from the -[releases page](https://github.com/microsoft/fabrikate/releases) or build the -bleeding edge from source with: +You have a couple options: + +### Official Release + +Grab the latest releases from the +[releases page](https://github.com/microsoft/fabrikate/releases) and place it +drop it into your `$PATH`. + +### Building From Source + +You have a couple options to build from source: + +**Using `go get`:** + +Use `go get` to build and install the bleeding edge (i.e `develop`) version into +`$GOPATH/bin`: + +```bash +(cd && GO111MODULE=on go get github.com/microsoft/fabrikate/cmd/fab@develop) +``` + +**Cloning locally:** ```bash git clone https://github.com/microsoft/fabrikate cd fabrikate -go build -o fab cmd/cli/main.go +go build -o fab cmd/fab/main.go ``` ## Getting Started diff --git a/cmd/cli/main.go b/cmd/fab/main.go similarity index 100% rename from cmd/cli/main.go rename to cmd/fab/main.go diff --git a/internal/cmd/version.go b/internal/cmd/version.go index 61066d2..d44019b 100644 --- a/internal/cmd/version.go +++ b/internal/cmd/version.go @@ -30,7 +30,7 @@ var versionCmd = &cobra.Command{ // PrintVersion prints the current version of Fabrikate being used. func PrintVersion() { - logger.Info("fab version 1.0.0-alpha0") + logger.Info("fab version 1.0.0-alpha1") } func init() { diff --git a/scripts/build b/scripts/build index 73cd373..c7f9c70 100755 --- a/scripts/build +++ b/scripts/build @@ -43,8 +43,8 @@ if [ $1 == "build" ]; then # build fabrikate if [ $2 == "fab" ]; then get-deps - echo "go build -o fab cmd/cli/main.go" - go build -o fab cmd/cli/main.go + echo "go build -o fab cmd/fab/main.go" + go build -o fab cmd/fab/main.go echo "finished building fab" fi @@ -61,11 +61,11 @@ if [ $1 == "build" ]; then mkdir -p releases/$3 echo "Building for Mac" - GOOS=darwin GOARCH=amd64 go build -o fab + GOOS=darwin GOARCH=amd64 go build -o fab cmd/fab/main.go zip releases/$3/fab-v$3-darwin-amd64.zip fab echo "Building for Linux" - GOOS=linux GOARCH=amd64 go build -o fab + GOOS=linux GOARCH=amd64 go build -o fab cmd/fab/main.go zip releases/$3/fab-v$3-linux-amd64.zip fab echo "Release zip files can be found in releases/$3"