diff --git a/README.md b/README.md index 86563759..f2ec319b 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,18 @@ go install github.com/melkeydev/go-blueprint@latest This installs a go binary that will automatically bind to your $GOPATH +> if you’re using Zsh, you’ll need to add it manually to `~/.zshrc`. + +```bash +GOPATH=$HOME/go PATH=$PATH:/usr/local/go/bin:$GOPATH/bin +``` + +don't forget to update + +```bash +source ~/.zshrc +``` + Then in a new terminal run: ```bash diff --git a/docs/docs/installation.md b/docs/docs/installation.md index c2fa9c31..852a103f 100644 --- a/docs/docs/installation.md +++ b/docs/docs/installation.md @@ -2,6 +2,7 @@ hide: - toc --- + Go-Blueprint provides a convenient CLI tool to effortlessly set up your Go projects. Follow the steps below to install the tool on your system. ## Binary Installation @@ -14,6 +15,26 @@ go install github.com/melkeydev/go-blueprint@latest This command installs the Go-Blueprint binary, automatically binding it to your `$GOPATH`. +> if you’re using Zsh, you’ll need to add it manually to `~/.zshrc`. + +> After running the installation command, you need to update your `PATH` environment variable. To do this, you need to find out the correct `GOPATH` for your system. You can do this by running the following command: +> Check your `GOPATH` +> +> ``` +> go env GOPATH +> ``` +> +> Then, add the following line to your `~/.zshrc` file: +> +> ``` +> GOPATH=$HOME/go PATH=$PATH:/usr/local/go/bin:$GOPATH/bin +> ``` +> +> Save the changes to your `~/.zshrc` file by running the following command: +> +> ``` +> source ~/.zshrc +> ``` ## Building and Installing from Source @@ -24,12 +45,13 @@ Clone the Go-Blueprint repository from GitHub: ```sh git clone https://github.com/melkeydev/go-blueprint ``` - + Build the Go-Blueprint binary: ```sh go build ``` + Install in your `$PATH` to make it accessible system-wide: ```sh