Commit graph

119 commits

Author SHA1 Message Date
Andy Feller
60af6bcb49 Initial installation doc refactor
These changes work to improve GitHub CLI users experience by bringing:

- clarity between official and unofficial installation methods
- insight into unofficial installation methods
- consistency across supported operating systems
2025-08-07 20:15:46 -04:00
Han
9594937d58
Update README.md 2025-05-25 18:45:56 +09:00
Fredrik Skogman
512fac2dba
Simplify cosign verification example by not using a regex. 2025-04-10 08:39:12 +02:00
Babak K. Shandiz
fc84b7a3cb
Escape dots in regexp pattern in example command
Signed-off-by: Babak K. Shandiz <babakks@github.com>
2025-04-07 15:21:48 +01:00
Azeem Sajid
d4271d4010 Fix typo in README 2025-02-14 12:42:46 +05:00
petercover
bad7098cfe chore: fix some comments
Signed-off-by: petercover <raowanxiang@outlook.com>
2025-01-23 00:47:27 +08:00
Andy Feller
78260967f9
Fix README.md code block formatting 2024-11-20 10:26:00 -05:00
Fredrik Skogman
075691b03e
Formatting fix
Signed-off-by: Fredrik Skogman <kommendorkapten@github.com>
2024-11-18 15:17:34 +01:00
Fredrik Skogman
601982faf1
Updated formatting to be more clear
Signed-off-by: Fredrik Skogman <kommendorkapten@github.com>
2024-11-18 15:16:47 +01:00
Fredrik Skogman
5098ea407a
Updated markdown syntax for a note.
Signed-off-by: Fredrik Skogman <kommendorkapten@github.com>
2024-11-18 14:48:34 +01:00
Fredrik Skogman
9168a5d7d8
Added a section on manual verification of the relases.
Signed-off-by: Fredrik Skogman <kommendorkapten@github.com>
2024-11-18 14:12:44 +01:00
Kynan Ware
15d86bbdf8
Clarify gh is available for GitHub Enterprise Cloud 2024-10-23 14:44:13 -06:00
Bryan Honof
a7d04fc2ec Add Flox as an installation option 2024-07-31 00:17:59 +02:00
Andy Feller
2bb99001cd Clarify Mac OS Installer packages are unsigned
Relates #9139

This commit clarifies Mac OS Installer packages are unsigned due to additional work to obtain an Apple Developer ID Installer-signing identity.
2024-05-29 10:31:39 -04:00
Andy Feller
bdc40a00d4 Update readme about MacOS pkg 2024-05-24 15:26:37 -04:00
Wésley Guimarães
57f6787c15
Add Webi as an option for installation (#8555) 2024-01-15 13:05:06 +01:00
Mateus Marquezini
8fed4e7270 small improvement 2023-12-07 18:20:40 +00:00
Mateus Marquezini
9b1c490f77 Removed repository requirement language from
documentation #8397
2023-12-07 18:15:43 +00:00
lerocknrolla
a0843e5d84
fixed a type
"affect" should have been "effect"
2023-06-09 12:31:56 +01:00
SonicGDX
66706f0880
Fix typo in README.md
Signed-off-by: SonicGDX<114670430+SonicGDX@users.noreply.github.com>
2023-03-29 17:36:40 +01:00
vilmibm
55c5e008cb link from readme 2023-01-06 17:22:50 -08:00
Aleksey Levenstein
c03b6ce891
docs: update codespace installation instructions (#6781) 2023-01-03 17:57:29 +00:00
Max Coplan
f57249f0dd
docs: Update installation instructions for WinGet (#6716)
Co-authored-by: Mislav Marohnić <mislav@github.com>
2022-12-12 13:38:56 +00:00
Mislav Marohnić
799aff18ae
Document installing GitHub CLI in Codespaces 2022-11-22 16:58:55 +01:00
Mislav Marohnić
231eb5dfb5 Clarify Linux installation instructions
This should draw attention to the fact that OS-specific package managers
are the preferred mode of installation, not OS-agnostic ones.
2022-09-21 20:06:52 +02:00
Edward Hartwell Goose
5f52a1d964
Improve setup instructions (#6156) 2022-09-02 09:43:41 +00:00
Alessio Franceschelli
961cd57b87
Update winget installation instructions 2021-10-13 15:01:50 +01:00
Luciano Zago
79832c1b04
Add instructions to gh installation via spack (#4412) 2021-10-08 09:14:49 +00:00
Mislav Marohnić
1ec632b1b8 Add OpenBSD instructions 2021-08-17 11:47:21 +02:00
chemotaxis
a72f6346dd 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.
2021-06-05 12:37:55 -04:00
chemotaxis
71c6b8f43a Add links to Conda section within each OS section 2021-06-05 00:48:36 -04:00
chemotaxis
71b738b553 Make whitespace consistent 2021-06-05 00:42:39 -04:00
chemotaxis
3caba02f3c 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.
2021-06-05 00:35:30 -04:00
itsme-alan
b51403391e
Update upgrade docs for winget 2021-05-31 13:22:35 +05:30
SADIK KUZU
0da3a19526
Capitalized h 2021-05-24 04:04:05 +03:00
Dan Greene
ca04e21921
Merge pull request #3681 from dgreene1/trunk
Describes usage in Github Actions
2021-05-20 20:03:44 +02:00
Vixb
37891a54d9
Update scoop install option (#2478)
Co-authored-by: Mislav Marohnić <mislav@github.com>
Co-authored-by: Jan Pokorný <JenomPokorny@gmail.com>
2020-11-25 11:40:30 +01:00
Alan Ninan Thomas
dd0b6de59f
Mention winget as an install option in README (#2272)
Co-authored-by: Mislav Marohnić <mislav@github.com>
2020-10-28 11:47:23 +01:00
Mislav Marohnić
b3f64acc55 Clarify contributions section 2020-10-13 17:44:13 +02:00
Mislav Marohnić
3d734a5e7e Merge remote-tracking branch 'origin' into help-wanted-docs 2020-10-13 17:43:12 +02:00
Mislav Marohnić
bb6a571ab5 Tweak contributing guidelines 2020-10-13 16:40:40 +02:00
Waldir Pimenta
10e1c5260c Suggested changes from PR review 2020-10-12 13:10:52 +01:00
Waldir Pimenta
d29fc16df9 Suggested changes from PR review 2020-10-12 11:57:43 +01:00
Waldir Pimenta
c38003d78b
Improve installation instructions
- Mention downloadable binaries for macOS and Linux
- Mention Homebrew for Linux
- Cleanup whitespace throughout the file
2020-10-11 10:57:04 +01:00
Antoine Leblanc
b047d63555
Add link to Homebrew and MacPorts 2020-10-04 21:17:48 +02:00
Jeremy Coghill
123f469e58 Fix links to files in the docs directory 2020-09-25 20:49:53 -04:00
Amanda Pinsker
f43a65a69f
Merge branch 'trunk' into readme-updates 2020-09-14 15:06:03 -04:00
Lee Reilly
527a1e466f Add auth command and flag usage to README 2020-09-08 14:07:33 -07:00
Amanda Pinsker
14c4331a51
tweak availability language 2020-09-08 12:46:45 -04:00
Amanda Pinsker
e10bbdd24f
Flip docs and feedback sections 2020-09-08 12:45:07 -04:00