kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add a note for GitHub SSH scheme

Browse source
This commit is contained in:
Albert Y 2022-01-13 10:01:13 +08:00
parent d29236141e
commit 5af3d57abb
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docs/user-setup.md
View file

@ -156,6 +156,10 @@ Preparing a user config for:
Continue? [Yn]:
```
:::note
If you are using SSH keys for GitHub push, change the repository field to the SSH scheme, e.g. `git@github.com:petejohanson/zmk-config.git'.
:::
After hitting `Enter` or typing `y`, the script will create an initial config in a directory named after the repo name,
update the GitHub Action YAML file, commit the initial version, and then push to your repo.