From 3a042cee52f1b2c1ad2fd4d4060c867ea869dbe4 Mon Sep 17 00:00:00 2001 From: Susilloxxxx Date: Fri, 29 Nov 2024 21:05:43 +0700 Subject: [PATCH 1/3] chore: improve ~/.zshrc config --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 86563759..39fe9c08 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 using zsh, you should add manualy at `~/.zshrc` + +```bash +GOPATH=$HOME/go PATH=$PATH:/usr/local/go/bin:$GOPATH/bin +``` + +dont forget to update + +```bash +source ~/.zshrc +``` + Then in a new terminal run: ```bash From b541795f43814bfa231e5c61c476f1e1ffb7835d Mon Sep 17 00:00:00 2001 From: Susilloxxxx Date: Fri, 29 Nov 2024 21:17:02 +0700 Subject: [PATCH 2/3] chore: adding extra step zsh at Readme --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 39fe9c08..f2ec319b 100644 --- a/README.md +++ b/README.md @@ -43,13 +43,13 @@ go install github.com/melkeydev/go-blueprint@latest This installs a go binary that will automatically bind to your $GOPATH -if you using zsh, you should add manualy at `~/.zshrc` +> 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 ``` -dont forget to update +don't forget to update ```bash source ~/.zshrc From 7b914dba828a1ddf57d82518dc6872f4d0e083d2 Mon Sep 17 00:00:00 2001 From: arafays Date: Wed, 11 Dec 2024 20:57:01 +0500 Subject: [PATCH 3/3] docs: update installation instructions for Zsh users --- docs/docs/installation.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) 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