Skip to content

Commit

Permalink
Update README and issues template
Browse files Browse the repository at this point in the history
  • Loading branch information
JBUinfo authored Sep 25, 2023
2 parents 6467102 + 40b8663 commit d10f636
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ body:
required: false
- type: textarea
attributes:
label: Logs, Screenshots, Screen Captures, etc
label: Logs, Screenshots, Screen Captures, URLs, etc
description: |
Logs? Links? References? Anything that will give us more context about the issue you are encountering!
placeholder: |
Expand Down
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,20 @@ Or download it from the [releases page][] and add it to your binaries folder:
mv ~/Downloads/gk /usr/local/bin/gk
```
______
### Unix
### Unix / Ubuntu
`gk` is available as a downloadable binary from the [releases page][]. Once you have it, add it to your binaries folder:

```bash
mv ~/Downloads/gk /usr/local/bin/gk
```

Or create a new directory, move the binary and add it to $PATH:
```bash
mkdir "$HOME/cli"
mv ~/Downloads/gk "$HOME/cli"
export PATH="$HOME/gk:$PATH"
```

You can also [download][releases page] your corresponding package (`.dev`, `.rpm`) and install it with:

```bash
Expand Down Expand Up @@ -73,6 +80,16 @@ Then edit your environment variables to add it to your PATH.
- If it doesn't exist, create a variable with the name **PATH**.
5. Add the path to the `gk` binary at the end.

## Troubleshooting

### ```gk login``` freezes after authenticating in browser
This problem is due to the browser. Currently we know that Safari and Brave do not allow to respond to localhost through port 1314. To fix this, change your default browser or copy the URL before the redirect and open it in another browser.

### gk from Oh-My-Zsh
Oh-My-Zsh has ```gitk``` aliased as ```gk``` and that can create some problems. To fix this, type in your terminal:

```unalias gk```

## Examples
### 🤝 Create Workspaces to group repos
```
Expand Down

0 comments on commit d10f636

Please sign in to comment.