From b438c255d640de041cfb0ebf94dfda85d8fffaa4 Mon Sep 17 00:00:00 2001 From: Jay Gabriels Date: Sat, 28 Oct 2023 11:00:07 -0700 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 4b6ac87..129460d 100644 --- a/README.md +++ b/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.