mirror of
https://github.com/outbackdingo/ghorg.git
synced 2026-01-27 10:19:03 +00:00
Update README.md
This commit is contained in:
25
README.md
25
README.md
@@ -46,24 +46,14 @@ If you have multiple different orgs/users/configurations to clone see the `ghorg
|
||||
|
||||
Note: ghorg will respect the `XDG_CONFIG_HOME` [environment variable](https://wiki.archlinux.org/title/XDG_Base_Directory) if set.
|
||||
|
||||
## Windows support
|
||||
|
||||
Windows is supported when built with golang or as a [prebuilt binary](https://github.com/gabrie30/ghorg/releases/latest) however, the readme and other documentation is not geared towards Windows users.
|
||||
|
||||
Alternatively, Windows users can also install ghorg using [scoop](https://scoop.sh/#/)
|
||||
|
||||
```
|
||||
scoop bucket add main
|
||||
scoop install ghorg
|
||||
```
|
||||
|
||||
## Installation
|
||||
|
||||
There are 4 installation methods available, please choose the one that suits your fancy:
|
||||
There are a installation methods available, please choose the one that suits your fancy:
|
||||
- [Homebrew](#homebrew)
|
||||
- [Golang](#golang)
|
||||
- [Prebuilt Binaries](#prebuilt-binaries)
|
||||
- [Docker](#docker)
|
||||
- [Windows Support](#windows-support)
|
||||
|
||||
### Homebrew
|
||||
|
||||
@@ -337,6 +327,17 @@ alias ghorg="docker run --rm -v $HOME/.config/ghorg:/config -v $HOME/repositorie
|
||||
ghorg clone kubernetes --match-regex=^sig
|
||||
```
|
||||
|
||||
## Windows support
|
||||
|
||||
Windows is supported when built with golang or as a [prebuilt binary](https://github.com/gabrie30/ghorg/releases/latest) however, the readme and other documentation is not geared towards Windows users.
|
||||
|
||||
Alternatively, Windows users can also install ghorg using [scoop](https://scoop.sh/#/)
|
||||
|
||||
```
|
||||
scoop bucket add main
|
||||
scoop install ghorg
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
- If you are having trouble cloning repos. Try to clone one of the repos locally e.g. manually running `git clone https://github.com/your_private_org/your_private_repo.git` if this does not work, ghorg will also not work. Your git client must first be setup to clone the target repos. If you normally clone using an ssh key use the `--protocol=ssh` flag with ghorg. This will fetch the ssh clone urls instead of the https clone urls.
|
||||
|
||||
Reference in New Issue
Block a user