Skip to content

Commit

Permalink
docs: update installation instructions for Zsh users
Browse files Browse the repository at this point in the history
  • Loading branch information
arafays committed Dec 11, 2024
1 parent b541795 commit 7b914db
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion docs/docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down

0 comments on commit 7b914db

Please sign in to comment.