From 3caba02f3c222be27449b70b8c83f26017b3acc8 Mon Sep 17 00:00:00 2001 From: chemotaxis Date: Sat, 5 Jun 2021 00:35:30 -0400 Subject: [PATCH 1/4] Add documentation for installing via Conda Conda is a cross-platform package and environment manager, primarily associated with the scientific computing and data science communities. --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 2886e3471..39856ec36 100644 --- a/README.md +++ b/README.md @@ -67,6 +67,18 @@ For more information and distro-specific instructions, see the [Linux installati MSI installers are available for download on the [releases page][]. +### Other package managers + +#### Conda + +`gh` is available via [Conda][], a cross-platform package and environment manager. + +| Install: | Upgrade: | +|------------------------------------------|-----------------------------------------| +| `conda install gh --channel conda-forge` | `conda update gh --channel conda-forge` | + +Additional installation options available on the [gh-feedstock page](https://github.com/conda-forge/gh-feedstock#installing-gh). + ### GitHub Actions GitHub CLI comes pre-installed in all [GitHub-Hosted Runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners). @@ -93,6 +105,7 @@ tool. Check out our [more detailed explanation][gh-vs-hub] to learn more. [winget]: https://github.com/microsoft/winget-cli [scoop]: https://scoop.sh [Chocolatey]: https://chocolatey.org +[Conda]: https://docs.conda.io/en/latest/ [releases page]: https://github.com/cli/cli/releases/latest [hub]: https://github.com/github/hub [contributing]: ./.github/CONTRIBUTING.md From 71b738b553ff22f17fc7c00e83bb66d54d315a64 Mon Sep 17 00:00:00 2001 From: chemotaxis Date: Sat, 5 Jun 2021 00:42:39 -0400 Subject: [PATCH 2/4] Make whitespace consistent --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 39856ec36..6279f182c 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,6 @@ GitHub CLI is available for repositories hosted on GitHub.com and GitHub Enterpr If anything feels off, or if you feel that some functionality is missing, please check out the [contributing page][contributing]. There you will find instructions for sharing your feedback, building the tool locally, and submitting pull requests to the project. - ## Installation @@ -44,7 +43,6 @@ For more information and distro-specific instructions, see the [Linux installati `gh` is available via [WinGet][], [scoop][], [Chocolatey][], and as downloadable MSI. - #### WinGet | Install: | Upgrade: | @@ -98,7 +96,6 @@ what an official GitHub CLI tool can look like with a fundamentally different de tools bring GitHub to the terminal, `hub` behaves as a proxy to `git`, and `gh` is a standalone tool. Check out our [more detailed explanation][gh-vs-hub] to learn more. - [manual]: https://cli.github.com/manual/ [Homebrew]: https://brew.sh [MacPorts]: https://www.macports.org From 71c6b8f43ab8fde443ce1ef2146246fae8ff07a1 Mon Sep 17 00:00:00 2001 From: chemotaxis Date: Sat, 5 Jun 2021 00:48:36 -0400 Subject: [PATCH 3/4] Add links to Conda section within each OS section --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6279f182c..d9c96cf89 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ If anything feels off, or if you feel that some functionality is missing, please ### macOS -`gh` is available via [Homebrew][], [MacPorts][], and as a downloadable binary from the [releases page][]. +`gh` is available via [Homebrew][], [MacPorts][], [Conda](#Conda), and as a downloadable binary from the [releases page][]. #### Homebrew @@ -35,13 +35,13 @@ If anything feels off, or if you feel that some functionality is missing, please ### Linux -`gh` is available via [Homebrew](#homebrew), and as downloadable binaries from the [releases page][]. +`gh` is available via [Homebrew](#homebrew), [Conda](#Conda), and as downloadable binaries from the [releases page][]. For more information and distro-specific instructions, see the [Linux installation docs](./docs/install_linux.md). ### Windows -`gh` is available via [WinGet][], [scoop][], [Chocolatey][], and as downloadable MSI. +`gh` is available via [WinGet][], [scoop][], [Chocolatey][], [Conda](#Conda), and as downloadable MSI. #### WinGet From a72f6346dd9dba218156759047ecc4a98b95fff6 Mon Sep 17 00:00:00 2001 From: chemotaxis Date: Sat, 5 Jun 2021 12:37:55 -0400 Subject: [PATCH 4/4] Rearrange Conda installation instructions Originally, I was thinking of putting Conda in a separate section after the Windows section, since Conda probably isn't as well known or used. But reading through the readme again, it seems like arranging it like the other instructions makes more sense. I found myself trying to look for the instructions when I first read it in the MacOS section, but couldn't find the instructions. --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index d9c96cf89..49d11ff70 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ If anything feels off, or if you feel that some functionality is missing, please ### macOS -`gh` is available via [Homebrew][], [MacPorts][], [Conda](#Conda), and as a downloadable binary from the [releases page][]. +`gh` is available via [Homebrew][], [MacPorts][], [Conda][], and as a downloadable binary from the [releases page][]. #### Homebrew @@ -33,6 +33,14 @@ If anything feels off, or if you feel that some functionality is missing, please | ---------------------- | ---------------------------------------------- | | `sudo port install gh` | `sudo port selfupdate && sudo port upgrade gh` | +#### Conda + +| Install: | Upgrade: | +|------------------------------------------|-----------------------------------------| +| `conda install gh --channel conda-forge` | `conda update gh --channel conda-forge` | + +Additional Conda installation options available on the [gh-feedstock page](https://github.com/conda-forge/gh-feedstock#installing-gh). + ### Linux `gh` is available via [Homebrew](#homebrew), [Conda](#Conda), and as downloadable binaries from the [releases page][]. @@ -65,18 +73,6 @@ For more information and distro-specific instructions, see the [Linux installati MSI installers are available for download on the [releases page][]. -### Other package managers - -#### Conda - -`gh` is available via [Conda][], a cross-platform package and environment manager. - -| Install: | Upgrade: | -|------------------------------------------|-----------------------------------------| -| `conda install gh --channel conda-forge` | `conda update gh --channel conda-forge` | - -Additional installation options available on the [gh-feedstock page](https://github.com/conda-forge/gh-feedstock#installing-gh). - ### GitHub Actions GitHub CLI comes pre-installed in all [GitHub-Hosted Runners](https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners).