Skip to content

Commit

Permalink
docs: add manual install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
mikesmithgh committed Apr 1, 2024
1 parent f1c3745 commit 2950d15
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ information about the current git branch and is inspired by
## 📦 Installation

### homebrew tap

```sh
brew install mikesmithgh/homebrew-git-prompt-string/git-prompt-string
```
Expand All @@ -27,6 +28,22 @@ brew install mikesmithgh/homebrew-git-prompt-string/git-prompt-string
go install github.com/mikesmithgh/git-prompt-string@latest
```

### manually
1. Download pre-compiled binary from [releases](https://github.com/mikesmithgh/git-prompt-string/releases/latest).
2. If you are on MacOS, run `xattr -c git-prompt-string*.tar.gz` to avoid "unknown developer" warning
3. Extract the `tar.gz` or `zip` file
4. Move `git-prompt-string` to a file location that is in your `PATH` environment variable
5. Run `git-prompt-string --version`

#### Example manually downloading via curl on MacOS

```sh
curl -L -o git-prompt-string.tar.gz https://github.com/mikesmithgh/git-prompt-string/releases/latest/download/git-prompt-string_Darwin_arm64.tar.gz
xattr -c git-prompt-string.tar.gz
tar xzvf git-prompt-string.tar.gz
mv git-prompt-string "$HOME/bin" # replace with your preferred directory that is in PATH
```

## 🛠️ Setup

### Prompt configuration
Expand Down

0 comments on commit 2950d15

Please sign in to comment.