Skip to content

Fix verb forms in README cloning instructions #10059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nohli wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix verb forms in README cloning instructions #10059

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ The two suggested workflows are:
### Cloning

1. Install [Git LFS](https://git-lfs.github.com/).
2. Run `git lfs install` to setup global git hooks. You only need to run this once per machine.
2. Run `git lfs install` to set up global Git hooks. You only need to run this once per machine.
3. SSH auth: `git clone git@github.com:microsoft/vscode-docs.git`<br>HTTPS auth: `git clone https://github.com/microsoft/vscode-docs.git`
4. Now you can `git add` binary files and commit them. They'll be tracked in LFS.

Expand All @@ -66,15 +66,15 @@ The two suggested workflows are:
You might want to clone the repo without the 1.6GB images. Here are the steps:

1. Install [Git LFS](https://git-lfs.github.com/).
2. Run `git lfs install` to setup global git hooks. You only need to run this once per machine.
2. Run `git lfs install` to set up global Git hooks. You only need to run this once per machine.
3. Clone the repo without binary files.
- macOS / Linux:
- SSH auth: `GIT_LFS_SKIP_SMUDGE=1 git clone git@github.com:microsoft/vscode-docs.git`
- HTTPS auth: `GIT_LFS_SKIP_SMUDGE=1 git clone https://github.com/microsoft/vscode-docs.git`
- Windows:
- SSH auth: `$env:GIT_LFS_SKIP_SMUDGE="1"; git clone git@github.com:microsoft/vscode-docs.git`
- HTTPS auth: `$env:GIT_LFS_SKIP_SMUDGE="1"; git clone https://github.com/microsoft/vscode-docs.git`
4. Now you can selectively checkout some binary files to work with. For example:
4. Now you can selectively check out some binary files to work with. For example:
- `git lfs pull -I "docs/nodejs"` to only download images in `docs/nodejs`
- `git lfs pull -I "release-notes/images/1_4*/*"` to only download images in `release-notes/images/1_4*`
- `git lfs pull -I "docs,api"` to download all images in `docs` and in `api`
Expand Down