Skip to content

Commit 1d95d78

Browse files
authored
docs: update installation instructions for Zsh users (#358)
1 parent f13c8b7 commit 1d95d78

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,18 @@ go install github.com/melkeydev/go-blueprint@latest
4343

4444
This installs a go binary that will automatically bind to your $GOPATH
4545

46+
> if you’re using Zsh, you’ll need to add it manually to `~/.zshrc`.
47+
48+
```bash
49+
GOPATH=$HOME/go PATH=$PATH:/usr/local/go/bin:$GOPATH/bin
50+
```
51+
52+
don't forget to update
53+
54+
```bash
55+
source ~/.zshrc
56+
```
57+
4658
Then in a new terminal run:
4759

4860
```bash

docs/docs/installation.md

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
hide:
33
- toc
44
---
5+
56
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.
67

78
## Binary Installation
@@ -14,6 +15,26 @@ go install github.com/melkeydev/go-blueprint@latest
1415

1516
This command installs the Go-Blueprint binary, automatically binding it to your `$GOPATH`.
1617

18+
> if you’re using Zsh, you’ll need to add it manually to `~/.zshrc`.
19+
20+
> 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:
21+
> Check your `GOPATH`
22+
>
23+
> ```
24+
> go env GOPATH
25+
> ```
26+
>
27+
> Then, add the following line to your `~/.zshrc` file:
28+
>
29+
> ```
30+
> GOPATH=$HOME/go PATH=$PATH:/usr/local/go/bin:$GOPATH/bin
31+
> ```
32+
>
33+
> Save the changes to your `~/.zshrc` file by running the following command:
34+
>
35+
> ```
36+
> source ~/.zshrc
37+
> ```
1738
1839
## Building and Installing from Source
1940
@@ -24,12 +45,13 @@ Clone the Go-Blueprint repository from GitHub:
2445
```sh
2546
git clone https://github.com/melkeydev/go-blueprint
2647
```
27-
48+
2849
Build the Go-Blueprint binary:
2950

3051
```sh
3152
go build
3253
```
54+
3355
Install in your `$PATH` to make it accessible system-wide:
3456

3557
```sh

0 commit comments

Comments
 (0)