From 2ad8f687c05dcbe2cc759a01174263d641554d16 Mon Sep 17 00:00:00 2001 From: Albert Y <76888457+filterpaper@users.noreply.github.com> Date: Thu, 13 Jan 2022 17:23:43 +0800 Subject: [PATCH] docs: Add a note for GitHub SSH scheme (#1089) Co-authored-by: Cem Aksoylar --- docs/docs/user-setup.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docs/user-setup.md b/docs/docs/user-setup.md index 6c80f882..de47680f 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: