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

Update note location

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

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

@ -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:
@ -156,10 +160,6 @@ 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.