Skip to content

Commit

Permalink
fix: update readme (#5)
Browse files Browse the repository at this point in the history
  • Loading branch information
ksamc authored Oct 2, 2022
1 parent 2b1bfc3 commit 4befbd8
Showing 1 changed file with 4 additions and 33 deletions.
37 changes: 4 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,17 @@
1. Docker Desktop (https://docs.docker.com/desktop/mac/install/)
2. Brew (https://brew.sh/)
3. Git (https://git-scm.com/)
4. Git Credential Manager Core (https://github.com/GitCredentialManager/git-credential-manager)
5. Visual Studio Code (https://code.visualstudio.com/)
4. Visual Studio Code (https://code.visualstudio.com/)
- Remote - Containers extension (https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
6. GITHUB_ACCESS_TOKEN environment variable
5. GITHUB_ACCESS_TOKEN environment variable

#### Linux
1. Docker Engine (https://docs.docker.com/engine/install/)
2. Docker Compose (https://docs.docker.com/compose/install/)
3. Git (https://git-scm.com/)
4. Git Credential Manager Core (https://github.com/GitCredentialManager/git-credential-manager)
5. Visual Studio Code (https://code.visualstudio.com/)
4. Visual Studio Code (https://code.visualstudio.com/)
- Remote - Containers extension (https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)
6. GITHUB_ACCESS_TOKEN environment variable
5. GITHUB_ACCESS_TOKEN environment variable

#### Windows

Expand Down Expand Up @@ -57,21 +55,6 @@ Configure Git to use your Oddcamp profile by setting your name and email:

```git config --global user.email <[email protected]>```

#### Git Credential Manager Core

Install the credential manager by running the following:

```shell
brew tap microsoft/git
brew install --cask git-credential-manager-core
```

After installing you can stay up-to-date with new releases by running:

```shell
brew upgrade git-credential-manager-core
```

#### Visual Studio Code

Install Docker Desktop by downloading the appropriate distribution for your system from the link above. Alternatively you can install it using Brew Casks by running the following:
Expand All @@ -96,20 +79,8 @@ Create a new token by visiting https://github.com/settings/tokens. Name it e.g.

**Important:** Give the token an expiration time of max 6 months.


## How to use

#### Git Credential Manager Core

Once it's installed and configured, Git Credential Manager is called implicitly by Git. You don't have to do anything special, and GCM isn't intended to be called directly by the user. For example, when pushing (git push) to Azure DevOps, Bitbucket, or GitHub, a window will automatically open and walk you through the sign-in process. (This process will look slightly different for each Git host, and even in some cases, whether you've connected to an on-premises or cloud-hosted Git host.) Later Git commands in the same repository will re-use existing credentials or tokens that GCM has stored for as long as they're valid.


## Additional Resources

#### Git Credential Manager Core

1. https://github.blog/2020-07-02-git-credential-manager-core-building-a-universal-authentication-experience/

#### Visual Studio Code

1. https://code.visualstudio.com/docs/remote/containers

0 comments on commit 4befbd8

Please sign in to comment.