Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update installation instructions for Zsh users #358

Merged
merged 3 commits into from
Dec 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
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
Loading