From 6252febad84130f52e9794fc131aaad29474db7f Mon Sep 17 00:00:00 2001 From: Evan Hearne Date: Thu, 23 May 2024 09:35:06 +0100 Subject: [PATCH] added additional make target instructions to README --- README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ee4431f..7b2d3fa 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ ### Compiling from Source -If you prefer to compile from source or are contributing to the project, you can install `kuadrantctl` using `go install`. This method requires Golang 1.21 or newer. +If you prefer to compile from source or are contributing to the project, you can install `kuadrantctl` using `go install` or `make install`. This method requires Golang 1.21 or newer. ```bash go install github.com/kuadrant/kuadrantctl@latest @@ -23,6 +23,14 @@ go install github.com/kuadrant/kuadrantctl@latest This command will compile `kuadrantctl` and install the binary executable in `$GOBIN` (defaulting to `$GOPATH/bin`). +It is also possible to use the make target `install` to compile from source. From root of the repository, run + +```bash +make install +``` + +This will compile `kuadrantctl` and install it in the `bin` directory at root of directory. It will also ensure the correct version of the binary is displayed, rather than `v0.0.0` . It can be ran using `./bin/kuadrantctl` . + ## Usage Below is a high-level overview of its commands, along with links to detailed documentation for more complex commands.