diff options
| author | Albert Y <76888457+filterpaper@users.noreply.github.com> | 2022-01-13 17:23:43 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-01-13 09:23:43 +0000 |
| commit | 2ad8f687c05dcbe2cc759a01174263d641554d16 (patch) | |
| tree | 2dedb9275aadca08ee60a0de48c5679a0b0684b4 /docs | |
| parent | 970e63bec6a63d498989ae5f358d60c8e538bf35 (diff) | |
docs: Add a note for GitHub SSH scheme (#1089)
Co-authored-by: Cem Aksoylar <caksoylar@users.noreply.github.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docs/user-setup.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md index 6c80f88..de47680 100644 --- a/docs/docs/user-setup.md +++ b/docs/docs/user-setup.md @@ -143,6 +143,10 @@ GitHub Repo: https://github.com/petejohanson/zmk-config.git Only the GitHub username is required; if you are happy with the defaults offered in the square brackets, you can simply hit `Enter`. +:::note +If you are using SSH keys for git push, change GitHub Repo field to the SSH scheme, e.g. `git@github.com:petejohanson/zmk-config.git`. +::: + ### Confirming Selections The setup script will confirm all of your selections one last time, before performing the setup: |