Skip to content

Commit b9084dd

Browse files
authored
docs: update readme explaining win install split
Update the readme file to explain the difference between the two Windows installers.
1 parent 8f96623 commit b9084dd

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,23 @@ git-credential-manager-core configure
114114

115115
### Windows
116116

117-
You can download the [latest installer](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest) for Windows. To install, double-click the installation package and follow the instructions presented.
117+
You can download the [latest installer](https://github.com/microsoft/Git-Credential-Manager-Core/releases/latest) for Windows to install GCM Core standalone.
118+
119+
**:warning: Important :warning:**
120+
121+
Installing GCM Core as a standalone package on Windows will forcably override the version of GCM Core that is bundled with Git for Windows, **even if the version bundled with Git for Windows is a later version**.
122+
123+
There are two flavors of standalone installation on Windows:
124+
125+
- User (preferred) (`gcmcoreuser-win*`):
126+
127+
Does not require administrator rights. Will install only for the current user and updates only the current user's Git configuration.
128+
129+
- System (`gcmcore-win*`):
130+
131+
Requires administrator rights. Will install for all users on the system and update the system-wide Git configuration.
132+
133+
To install, double-click the desired installation package and follow the instructions presented.
118134

119135
#### Git Credential Manager for Windows
120136

0 commit comments

Comments
 (0)